NAME¶

mtext_pop_prop -

SYNOPSIS¶

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

DESCRIPTION¶

@brief Pop a text property.
The mtext_pop_prop() function removes the topmost text property
whose key is @b key from the characters between @b from (inclusive)
and and @b to (exclusive) in @b 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-->|

@par 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.   
@par Errors:
@c MERROR_RANGE, @c MERROR_SYMBOL
@par See Also:
mtext_put_prop(), mtext_put_prop_values(),
mtext_get_prop(), mtext_get_prop_values(),
mtext_push_prop(), mtext_prop_range()   

COPYRIGHT¶

Copyright (C) 2001 Information-technology Promotion Agency (IPA)
Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology (AIST)
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License <http://www.gnu.org/licenses/fdl.html>.