Scroll to navigation

mtext_pop_prop(3m17n) The m17n Library mtext_pop_prop(3m17n)

NAME

mtext_pop_prop - Pop a text property.
 
 

SYNOPSIS

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

DESCRIPTION

Pop a text property. 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()
 

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>.
12 Jan 2011 Version 1.6.2