Function: get-text-property

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

Signature

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

Documentation

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

OBJECT should be a buffer or a string; if omitted or nil, it defaults to the current buffer.

If POSITION is at the end of OBJECT, the value is nil, but note that buffer narrowing does not affect the value. That is, if the buffer is narrowed and POSITION is at the end of the narrowed buffer, the result may be non-nil.

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-text-property 0 'foo (propertize "x" 'foo t))
    => t

Aliases

kproperty:get

Source Code

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