logo
Free, Micro AI Code Reviews That Run on Git Commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, Micro AI Code Reviews That Run on Git Commit | Product Hunt git-lrc - Free, Micro AI Code Reviews That Run on Git Commit | Product Hunt

mtext_get_prop -

Description

       Get the value of the topmost text property. The mtext_get_prop() function searches the character at pos
       in M-text mt for the text property whose key is key.

Errors

           MERROR_RANGE, MERROR_SYMBOL

Name

       mtext_get_prop -

Return Value

           If a text property is found, mtext_get_prop() returns the value of the property. If the property has
           multiple values, it returns the topmost one. If no such property is found, it returns NULL without
           changing the external variable merror_code.

       If an error is detected, mtext_get_prop() returns NULL and assigns an error code to the external variable
       merror_code.

       Note

           If NULL is returned without an error, there are two possibilities:

       • the character at pos does not have a property whose key is key, or
       • the character does have such a property and its value is NULL.

       If you need to distinguish these two cases, use the mtext_get_prop_values() function instead.

See Also

mtext_get_prop_values(),      mtext_put_prop(),      mtext_put_prop_values(),      mtext_push_prop(),
           mtext_pop_prop(), mtext_prop_range()

Synopsis

       void* mtext_get_prop (MText * mt, int pos, MSymbol key)

See Also