Function: get-char-property

get-char-property is a function defined in textprop.c.

Signature

(get-char-property POSITION PROP &optional OBJECT)

Documentation

Return the value of POSITION's property PROP, in OBJECT.

Both overlay properties and text properties are checked. OBJECT is optional and defaults to the current buffer. If POSITION is at the end of OBJECT, the value is nil. If OBJECT is a buffer, then overlay properties are considered as well as text properties. If OBJECT is a window, then that window's buffer is used, but window-specific overlays are considered only if they are associated with OBJECT.

Other relevant functions are documented in the text-properties group.

View in manual

Probably introduced at or before Emacs version 19.23.

Shortdoc

;; text-properties
(get-char-property 0 'foo (propertize "x" 'foo t))
    => t

Source Code

// Defined in /usr/src/emacs/src/textprop.c
{
  return get_char_property_and_overlay (position, prop, object, 0);
}