Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mtext_serialize(3m17n) [debian man page]

mtext_serialize(3m17n)						 The m17n Library					    mtext_serialize(3m17n)

NAME

       mtext_serialize - Serialize text properties in an M-text.

SYNOPSIS

       MText* mtext_serialize (MText * mt, int from, int to, MPlist * property_list)

DESCRIPTION

       Serialize text properties in an M-text. The mtext_serialize() function serializes the text between from and to in M-text mt.  The
       serialized result is an M-text in a form of XML.  property_list limits the text properties to be serialized. Only those text properties
       whose key

       o appears as the value of an element in property_list, and
       o has the symbol property Mtext_prop_serializer
       are serialized as a 'property' element in the resulting XML representation.
       The DTD of the generated XML is as follows:
       <!DOCTYPE mtext [
	 <!ELEMENT mtext (property*,body+)>
	 <!ELEMENT property EMPTY>
	 <!ELEMENT body (#PCDATA)>
	 <!ATTLIST property key CDATA #REQUIRED>
	 <!ATTLIST property value CDATA #REQUIRED>
	 <!ATTLIST property from CDATA #REQUIRED>
	 <!ATTLIST property to CDATA #REQUIRED>
	 <!ATTLIST property control CDATA #REQUIRED>
	]>
       This function depends on the libxml2 library. If the m17n library is configured without libxml2, this function always fails.
RETURN VALUE

	   If the operation was successful, mtext_serialize() returns an M-text in the form of XML. Otherwise it returns NULL and assigns an error
	   code to the external variable merror_code.
SEE ALSO

	   mtext_deserialize(), Mtext_prop_serializer
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>.

Version 1.6.2							    12 Jan 2011 					    mtext_serialize(3m17n)

Check Out this Related Man Page

mtext_push_prop(3m17n)						 The m17n Library					    mtext_push_prop(3m17n)

NAME

       mtext_push_prop - Push a text property.

SYNOPSIS

       int mtext_push_prop (MText * mt, int from, int to, MSymbol key, void * val)

DESCRIPTION

       Push a text property. The mtext_push_prop() function pushes a text property whose key is key and value is val to the characters between
       from (inclusive) and to (exclusive) in M-text mt.  With this function,

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

       becomes

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

RETURN VALUE

	   If the operation was successful, mtext_push_prop() returns 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_pop_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>.

Version 1.6.2							    12 Jan 2011 					    mtext_push_prop(3m17n)
Man Page