man mtext_pop_prop () - Pop a text property.

NAME

mtext_pop_prop - Pop a text property.

SYNOPSIS

int mtext_pop_prop (MText * mt, int from, int to, MSymbol key)

DESCRIPTION

The mtext_pop_prop() function removes the topmost text property whose key is key from the characters between from (inclusive) and and to (exclusive) in mt.

This function does nothing if characters in the region have no such text property. With this function, 

                    FROM                    TO
M-text: |<------------|-------- MT ---------|------------>|
PROP  :  <------------------ OLD_VAL -------------------->




becomes





 
                    FROM                    TO
M-text: |<------------|-------- MT ---------|------------>|
PROP  :  <--OLD_VAL-->|                     |<--OLD_VAL-->|






RETURN VALUE

If the operation was successful,
mtext_pop_prop()
return 0. Otherwise it returns -1 and assigns an error code to the external variable
merror_code.



ERRORS

MERROR_RANGE,
MERROR_SYMBOL



SEE ALSO

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