.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mtext_deserialize" 3m17n "Mon Sep 25 2023" "Version 1.8.4" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_deserialize \- 


.SH SYNOPSIS
\fBMText\fP*
\fBmtext_deserialize\fP (\fBMText\fP *
\fImt\fP)


.SH DESCRIPTION
.PP
.nf
@brief Deserialize text properties in an M\-text.

The mtext_deserialize() function deserializes M\-text @b mt.  @b mt
must be an XML having the following DTD.

.fi
.fi
 
.PP
.nf
<!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>
 ]>

.fi
.fi
 
.PP
.nf
This function depends on the libxml2 library.  If the m17n library
is configured without libxml2, this function always fail.

@par Return value:
If the operation was successful, mtext_deserialize() returns the
resulting M\-text.  Otherwise it returns @c NULL and assigns an error
code to the external variable #merror_code.

@par See Also:
mtext_serialize(), #Mtext_prop_deserializer   

.fi
.fi
 
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
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>.