|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
|
|
<html>
|
|
|
|
<head>
|
|
|
|
<title>Documentation</title>
|
|
|
|
<meta name='creator' content='Mini-XML v2.4'>
|
|
|
|
<style type='text/css'><!--
|
|
|
|
body, p, h1, h2, h3, h4 {
|
|
|
|
font-family: lucida grande, geneva, helvetica, arial, sans-serif;
|
|
|
|
text-align: justify;
|
|
|
|
}
|
|
|
|
h1 {
|
|
|
|
font-size: 250%;
|
|
|
|
font-weight: bold;
|
|
|
|
}
|
|
|
|
h2 {
|
|
|
|
font-size: 250%;
|
|
|
|
margin-top: 2.5em;
|
|
|
|
}
|
|
|
|
h3 {
|
|
|
|
font-size: 150%;
|
|
|
|
margin-bottom: 0.5em;
|
|
|
|
margin-top: 2em;
|
|
|
|
}
|
|
|
|
h4 {
|
|
|
|
font-size: 110%;
|
|
|
|
margin-bottom: 0.5em;
|
|
|
|
margin-top: 2em;
|
|
|
|
}
|
|
|
|
.class {
|
|
|
|
}
|
|
|
|
.discussion {
|
|
|
|
}
|
|
|
|
.enum {
|
|
|
|
}
|
|
|
|
.function {
|
|
|
|
margin-bottom: 0;
|
|
|
|
}
|
|
|
|
.members {
|
|
|
|
}
|
|
|
|
.parameters {
|
|
|
|
}
|
|
|
|
.returnvalue {
|
|
|
|
}
|
|
|
|
.struct {
|
|
|
|
}
|
|
|
|
.typedef {
|
|
|
|
}
|
|
|
|
.union {
|
|
|
|
}
|
|
|
|
.variable {
|
|
|
|
}
|
|
|
|
p.summary {
|
|
|
|
margin-top: 0.5em;
|
|
|
|
}
|
|
|
|
code, p.code, pre, ul.code li {
|
|
|
|
font-family: monaco, courier, monospace;
|
|
|
|
font-size: 90%;
|
|
|
|
}
|
|
|
|
a:link, a:visited {
|
|
|
|
text-decoration: none;
|
|
|
|
}
|
|
|
|
span.info {
|
|
|
|
background: black;
|
|
|
|
border: solid thin black;
|
|
|
|
color: white;
|
|
|
|
font-size: 80%;
|
|
|
|
font-style: italic;
|
|
|
|
font-weight: bold;
|
|
|
|
white-space: nowrap;
|
|
|
|
}
|
|
|
|
ul.code {
|
|
|
|
list-style-type: none;
|
|
|
|
margin: 0;
|
|
|
|
}
|
|
|
|
ul.code li {
|
|
|
|
margin: 0;
|
|
|
|
}
|
|
|
|
dl {
|
|
|
|
margin-top: 0;
|
|
|
|
}
|
|
|
|
dt {
|
|
|
|
font-style: italic;
|
|
|
|
margin-top: 0;
|
|
|
|
}
|
|
|
|
dd {
|
|
|
|
margin-bottom: 0.5em;
|
|
|
|
}
|
|
|
|
h3 span.info {
|
|
|
|
float: right;
|
|
|
|
font-size: 100%;
|
|
|
|
}
|
|
|
|
h1.title, h2.title, h3.title {
|
|
|
|
border-bottom: solid 1px black;
|
|
|
|
}
|
|
|
|
--></style>
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h1 align='right'><a name='REFERENCE'><img src="C.gif" align="right"
|
|
|
|
hspace="10" width="100" height="100" alt="C"></a>Library
|
|
|
|
Reference</h1>
|
|
|
|
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h2 class='title'><a name='FUNCTIONS'>Functions</a></h2>
|
|
|
|
<ul class='code'>
|
|
|
|
<li><a href='#mxmlAdd'>mxmlAdd</a> </li>
|
|
|
|
<li><a href='#mxmlDelete'>mxmlDelete</a> </li>
|
|
|
|
<li><a href='#mxmlElementDeleteAttr'>mxmlElementDeleteAttr</a> <span class='info'> Mini-XML 2.4 </span></li>
|
|
|
|
<li><a href='#mxmlElementGetAttr'>mxmlElementGetAttr</a> </li>
|
|
|
|
<li><a href='#mxmlElementSetAttr'>mxmlElementSetAttr</a> </li>
|
|
|
|
<li><a href='#mxmlElementSetAttrf'>mxmlElementSetAttrf</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlEntityAddCallback'>mxmlEntityAddCallback</a> </li>
|
|
|
|
<li><a href='#mxmlEntityGetName'>mxmlEntityGetName</a> </li>
|
|
|
|
<li><a href='#mxmlEntityGetValue'>mxmlEntityGetValue</a> </li>
|
|
|
|
<li><a href='#mxmlEntityRemoveCallback'>mxmlEntityRemoveCallback</a> </li>
|
|
|
|
<li><a href='#mxmlFindElement'>mxmlFindElement</a> </li>
|
|
|
|
<li><a href='#mxmlIndexDelete'>mxmlIndexDelete</a> </li>
|
|
|
|
<li><a href='#mxmlIndexEnum'>mxmlIndexEnum</a> </li>
|
|
|
|
<li><a href='#mxmlIndexFind'>mxmlIndexFind</a> </li>
|
|
|
|
<li><a href='#mxmlIndexNew'>mxmlIndexNew</a> </li>
|
|
|
|
<li><a href='#mxmlIndexReset'>mxmlIndexReset</a> </li>
|
|
|
|
<li><a href='#mxmlLoadFd'>mxmlLoadFd</a> </li>
|
|
|
|
<li><a href='#mxmlLoadFile'>mxmlLoadFile</a> </li>
|
|
|
|
<li><a href='#mxmlLoadString'>mxmlLoadString</a> </li>
|
|
|
|
<li><a href='#mxmlNewCDATA'>mxmlNewCDATA</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlNewCustom'>mxmlNewCustom</a> <span class='info'> Mini-XML 2.1 </span></li>
|
|
|
|
<li><a href='#mxmlNewElement'>mxmlNewElement</a> </li>
|
|
|
|
<li><a href='#mxmlNewInteger'>mxmlNewInteger</a> </li>
|
|
|
|
<li><a href='#mxmlNewOpaque'>mxmlNewOpaque</a> </li>
|
|
|
|
<li><a href='#mxmlNewReal'>mxmlNewReal</a> </li>
|
|
|
|
<li><a href='#mxmlNewText'>mxmlNewText</a> </li>
|
|
|
|
<li><a href='#mxmlNewTextf'>mxmlNewTextf</a> </li>
|
|
|
|
<li><a href='#mxmlNewXML'>mxmlNewXML</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlRelease'>mxmlRelease</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlRemove'>mxmlRemove</a> </li>
|
|
|
|
<li><a href='#mxmlRetain'>mxmlRetain</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlSAXLoadFd'>mxmlSAXLoadFd</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlSAXLoadFile'>mxmlSAXLoadFile</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlSAXLoadString'>mxmlSAXLoadString</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlSaveAllocString'>mxmlSaveAllocString</a> </li>
|
|
|
|
<li><a href='#mxmlSaveFd'>mxmlSaveFd</a> </li>
|
|
|
|
<li><a href='#mxmlSaveFile'>mxmlSaveFile</a> </li>
|
|
|
|
<li><a href='#mxmlSaveString'>mxmlSaveString</a> </li>
|
|
|
|
<li><a href='#mxmlSetCDATA'>mxmlSetCDATA</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlSetCustom'>mxmlSetCustom</a> <span class='info'> Mini-XML 2.1 </span></li>
|
|
|
|
<li><a href='#mxmlSetCustomHandlers'>mxmlSetCustomHandlers</a> </li>
|
|
|
|
<li><a href='#mxmlSetElement'>mxmlSetElement</a> </li>
|
|
|
|
<li><a href='#mxmlSetErrorCallback'>mxmlSetErrorCallback</a> </li>
|
|
|
|
<li><a href='#mxmlSetInteger'>mxmlSetInteger</a> </li>
|
|
|
|
<li><a href='#mxmlSetOpaque'>mxmlSetOpaque</a> </li>
|
|
|
|
<li><a href='#mxmlSetReal'>mxmlSetReal</a> </li>
|
|
|
|
<li><a href='#mxmlSetText'>mxmlSetText</a> </li>
|
|
|
|
<li><a href='#mxmlSetTextf'>mxmlSetTextf</a> </li>
|
|
|
|
<li><a href='#mxmlSetWrapMargin'>mxmlSetWrapMargin</a> <span class='info'> Mini-XML 2.3 </span></li>
|
|
|
|
<li><a href='#mxmlWalkNext'>mxmlWalkNext</a> </li>
|
|
|
|
<li><a href='#mxmlWalkPrev'>mxmlWalkPrev</a> </li>
|
|
|
|
</ul>
|
|
|
|
<h3 class='function'><a name="mxmlAdd">mxmlAdd</a></h3>
|
|
|
|
<p class='summary'>Add a node to a tree.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlAdd (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
int where,<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *child,<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node</dd>
|
|
|
|
<dt>where</dt>
|
|
|
|
<dd class='summary'>Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER</dd>
|
|
|
|
<dt>child</dt>
|
|
|
|
<dd class='summary'>Child node for where or MXML_ADD_TO_PARENT</dd>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to add</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>Adds the specified node to the parent. If the child argument is not
|
|
|
|
NULL, puts the new node before or after the specified child depending
|
|
|
|
on the value of the where argument. If the child argument is NULL,
|
|
|
|
puts the new node at the beginning of the child list (MXML_ADD_BEFORE)
|
|
|
|
or at the end of the child list (MXML_ADD_AFTER). The constant
|
|
|
|
MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.</p>
|
|
|
|
<h3 class='function'><a name="mxmlDelete">mxmlDelete</a></h3>
|
|
|
|
<p class='summary'>Delete a node and all of its children.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlDelete (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to delete</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>If the specified node has a parent, this function first removes the
|
|
|
|
node from its parent using the mxmlRemove() function.</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.4 </span><a name="mxmlElementDeleteAttr">mxmlElementDeleteAttr</a></h3>
|
|
|
|
<p class='summary'>Delete an attribute.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlElementDeleteAttr (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
const char *name<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Element</dd>
|
|
|
|
<dt>name</dt>
|
|
|
|
<dd class='summary'>Attribute name</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'></p>
|
|
|
|
<h3 class='function'><a name="mxmlElementGetAttr">mxmlElementGetAttr</a></h3>
|
|
|
|
<p class='summary'>Get an attribute.</p>
|
|
|
|
<p class='code'>
|
|
|
|
const char *mxmlElementGetAttr (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
const char *name<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Element node</dd>
|
|
|
|
<dt>name</dt>
|
|
|
|
<dd class='summary'>Name of attribute</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Attribute value or NULL</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>This function returns NULL if the node is not an element or the
|
|
|
|
named attribute does not exist.</p>
|
|
|
|
<h3 class='function'><a name="mxmlElementSetAttr">mxmlElementSetAttr</a></h3>
|
|
|
|
<p class='summary'>Set an attribute.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlElementSetAttr (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
const char *name,<br>
|
|
|
|
const char *value<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Element node</dd>
|
|
|
|
<dt>name</dt>
|
|
|
|
<dd class='summary'>Name of attribute</dd>
|
|
|
|
<dt>value</dt>
|
|
|
|
<dd class='summary'>Attribute value</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>If the named attribute already exists, the value of the attribute
|
|
|
|
is replaced by the new string value. The string value is copied
|
|
|
|
into the element node. This function does nothing if the node is
|
|
|
|
not an element.</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlElementSetAttrf">mxmlElementSetAttrf</a></h3>
|
|
|
|
<p class='summary'>Set an attribute with a formatted value.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlElementSetAttrf (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
const char *name,<br>
|
|
|
|
const char *format,<br>
|
|
|
|
...<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Element node</dd>
|
|
|
|
<dt>name</dt>
|
|
|
|
<dd class='summary'>Name of attribute</dd>
|
|
|
|
<dt>format</dt>
|
|
|
|
<dd class='summary'>Printf-style attribute value</dd>
|
|
|
|
<dt>...</dt>
|
|
|
|
<dd class='summary'>Additional arguments as needed</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>If the named attribute already exists, the value of the attribute
|
|
|
|
is replaced by the new formatted string. The formatted string value is
|
|
|
|
copied into the element node. This function does nothing if the node
|
|
|
|
is not an element.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><a name="mxmlEntityAddCallback">mxmlEntityAddCallback</a></h3>
|
|
|
|
<p class='summary'>Add a callback to convert entities to Unicode.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlEntityAddCallback (void);</p>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h3 class='function'><a name="mxmlEntityGetName">mxmlEntityGetName</a></h3>
|
|
|
|
<p class='summary'>Get the name that corresponds to the character value.</p>
|
|
|
|
<p class='code'>
|
|
|
|
const char *mxmlEntityGetName (<br>
|
|
|
|
int val<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>val</dt>
|
|
|
|
<dd class='summary'>Character value</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Entity name or NULL</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>If val does not need to be represented by a named entity, NULL is returned.</p>
|
|
|
|
<h3 class='function'><a name="mxmlEntityGetValue">mxmlEntityGetValue</a></h3>
|
|
|
|
<p class='summary'>Get the character corresponding to a named entity.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlEntityGetValue (<br>
|
|
|
|
const char *name<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>name</dt>
|
|
|
|
<dd class='summary'>Entity name</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Character value or -1 on error</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The entity name can also be a numeric constant. -1 is returned if the
|
|
|
|
name is not known.</p>
|
|
|
|
<h3 class='function'><a name="mxmlEntityRemoveCallback">mxmlEntityRemoveCallback</a></h3>
|
|
|
|
<p class='summary'>Remove a callback.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlEntityRemoveCallback (void);</p>
|
|
|
|
<h3 class='function'><a name="mxmlFindElement">mxmlFindElement</a></h3>
|
|
|
|
<p class='summary'>Find the named element.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlFindElement (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
const char *name,<br>
|
|
|
|
const char *attr,<br>
|
|
|
|
const char *value,<br>
|
|
|
|
int descend<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Current node</dd>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>name</dt>
|
|
|
|
<dd class='summary'>Element name or NULL for any</dd>
|
|
|
|
<dt>attr</dt>
|
|
|
|
<dd class='summary'>Attribute name, or NULL for none</dd>
|
|
|
|
<dt>value</dt>
|
|
|
|
<dd class='summary'>Attribute value, or NULL for any</dd>
|
|
|
|
<dt>descend</dt>
|
|
|
|
<dd class='summary'>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Element node or NULL</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The search is constrained by the name, attribute name, and value; any
|
|
|
|
NULL names or values are treated as wildcards, so different kinds of
|
|
|
|
searches can be implemented by looking for all elements of a given name
|
|
|
|
or all elements with a specific attribute. The descend argument determines
|
|
|
|
whether the search descends into child nodes; normally you will use
|
|
|
|
MXML_DESCEND_FIRST for the initial search and MXML_NO_DESCEND to find
|
|
|
|
additional direct descendents of the node. The top node argument
|
|
|
|
constrains the search to a particular node's children.</p>
|
|
|
|
<h3 class='function'><a name="mxmlIndexDelete">mxmlIndexDelete</a></h3>
|
|
|
|
<p class='summary'>Delete an index.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlIndexDelete (<br>
|
|
|
|
<a href='#mxml_index_t'>mxml_index_t</a> *ind<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>ind</dt>
|
|
|
|
<dd class='summary'>Index to delete</dd>
|
|
|
|
</dl>
|
|
|
|
<h3 class='function'><a name="mxmlIndexEnum">mxmlIndexEnum</a></h3>
|
|
|
|
<p class='summary'>Return the next node in the index.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlIndexEnum (<br>
|
|
|
|
<a href='#mxml_index_t'>mxml_index_t</a> *ind<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>ind</dt>
|
|
|
|
<dd class='summary'>Index to enumerate</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Next node or NULL if there is none</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>Nodes are returned in the sorted order of the index.</p>
|
|
|
|
<h3 class='function'><a name="mxmlIndexFind">mxmlIndexFind</a></h3>
|
|
|
|
<p class='summary'>Find the next matching node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlIndexFind (<br>
|
|
|
|
<a href='#mxml_index_t'>mxml_index_t</a> *ind,<br>
|
|
|
|
const char *element,<br>
|
|
|
|
const char *value<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>ind</dt>
|
|
|
|
<dd class='summary'>Index to search</dd>
|
|
|
|
<dt>element</dt>
|
|
|
|
<dd class='summary'>Element name to find, if any</dd>
|
|
|
|
<dt>value</dt>
|
|
|
|
<dd class='summary'>Attribute value, if any</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Node or NULL if none found</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>You should call mxmlIndexReset() prior to using this function for
|
|
|
|
the first time with a particular set of "element" and "value"
|
|
|
|
strings. Passing NULL for both "element" and "value" is equivalent
|
|
|
|
to calling mxmlIndexEnum().</p>
|
|
|
|
<h3 class='function'><a name="mxmlIndexNew">mxmlIndexNew</a></h3>
|
|
|
|
<p class='summary'>Create a new index.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_index_t'>mxml_index_t</a> *mxmlIndexNew (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
const char *element,<br>
|
|
|
|
const char *attr<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>XML node tree</dd>
|
|
|
|
<dt>element</dt>
|
|
|
|
<dd class='summary'>Element to index or NULL for all</dd>
|
|
|
|
<dt>attr</dt>
|
|
|
|
<dd class='summary'>Attribute to index or NULL for none</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New index</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The index will contain all nodes that contain the named element and/or
|
|
|
|
attribute. If both "element" and "attr" are NULL, then the index will
|
|
|
|
contain a sorted list of the elements in the node tree. Nodes are
|
|
|
|
sorted by element name and optionally by attribute value if the "attr"
|
|
|
|
argument is not NULL.</p>
|
|
|
|
<h3 class='function'><a name="mxmlIndexReset">mxmlIndexReset</a></h3>
|
|
|
|
<p class='summary'>Reset the enumeration/find pointer in the index and
|
|
|
|
return the first node in the index.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlIndexReset (<br>
|
|
|
|
<a href='#mxml_index_t'>mxml_index_t</a> *ind<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>ind</dt>
|
|
|
|
<dd class='summary'>Index to reset</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>First node or NULL if there is none</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>This function should be called prior to using mxmlIndexEnum() or
|
|
|
|
mxmlIndexFind() for the first time.</p>
|
|
|
|
<h3 class='function'><a name="mxmlLoadFd">mxmlLoadFd</a></h3>
|
|
|
|
<p class='summary'>Load a file descriptor into an XML node tree.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlLoadFd (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
int fd,<br>
|
|
|
|
<a href='#mxml_load_cb_t'>mxml_load_cb_t</a> cb<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>fd</dt>
|
|
|
|
<dd class='summary'>File descriptor to read from</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Callback function or MXML_NO_CALLBACK</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>First node or NULL if the file could not be read.</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The nodes in the specified file are added to the specified top node.
|
|
|
|
If no top node is provided, the XML file MUST be well-formed with a
|
|
|
|
single parent node like <?xml> for the entire file. The callback
|
|
|
|
function returns the value type that should be used for child nodes.
|
|
|
|
If MXML_NO_CALLBACK is specified then all child nodes will be either
|
|
|
|
MXML_ELEMENT or MXML_TEXT nodes.<br>
|
|
|
|
<br>
|
|
|
|
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
|
|
|
|
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
|
|
|
|
child nodes of the specified type.</p>
|
|
|
|
<h3 class='function'><a name="mxmlLoadFile">mxmlLoadFile</a></h3>
|
|
|
|
<p class='summary'>Load a file into an XML node tree.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlLoadFile (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
FILE *fp,<br>
|
|
|
|
<a href='#mxml_load_cb_t'>mxml_load_cb_t</a> cb<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>fp</dt>
|
|
|
|
<dd class='summary'>File to read from</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Callback function or MXML_NO_CALLBACK</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>First node or NULL if the file could not be read.</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The nodes in the specified file are added to the specified top node.
|
|
|
|
If no top node is provided, the XML file MUST be well-formed with a
|
|
|
|
single parent node like <?xml> for the entire file. The callback
|
|
|
|
function returns the value type that should be used for child nodes.
|
|
|
|
If MXML_NO_CALLBACK is specified then all child nodes will be either
|
|
|
|
MXML_ELEMENT or MXML_TEXT nodes.<br>
|
|
|
|
<br>
|
|
|
|
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
|
|
|
|
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
|
|
|
|
child nodes of the specified type.</p>
|
|
|
|
<h3 class='function'><a name="mxmlLoadString">mxmlLoadString</a></h3>
|
|
|
|
<p class='summary'>Load a string into an XML node tree.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlLoadString (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
const char *s,<br>
|
|
|
|
<a href='#mxml_load_cb_t'>mxml_load_cb_t</a> cb<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>s</dt>
|
|
|
|
<dd class='summary'>String to load</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Callback function or MXML_NO_CALLBACK</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>First node or NULL if the string has errors.</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The nodes in the specified string are added to the specified top node.
|
|
|
|
If no top node is provided, the XML string MUST be well-formed with a
|
|
|
|
single parent node like <?xml> for the entire string. The callback
|
|
|
|
function returns the value type that should be used for child nodes.
|
|
|
|
If MXML_NO_CALLBACK is specified then all child nodes will be either
|
|
|
|
MXML_ELEMENT or MXML_TEXT nodes.<br>
|
|
|
|
<br>
|
|
|
|
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
|
|
|
|
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
|
|
|
|
child nodes of the specified type.</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlNewCDATA">mxmlNewCDATA</a></h3>
|
|
|
|
<p class='summary'>Create a new CDATA node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewCDATA (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
const char *data<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node or MXML_NO_PARENT</dd>
|
|
|
|
<dt>data</dt>
|
|
|
|
<dd class='summary'>Data string</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The new CDATA node is added to the end of the specified parent's child
|
|
|
|
list. The constant MXML_NO_PARENT can be used to specify that the new
|
|
|
|
CDATA node has no parent. The data string must be nul-terminated and
|
|
|
|
is copied into the new node. CDATA nodes use the MXML_ELEMENT type.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.1 </span><a name="mxmlNewCustom">mxmlNewCustom</a></h3>
|
|
|
|
<p class='summary'>Create a new custom data node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewCustom (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
void *data,<br>
|
|
|
|
<a href='#mxml_custom_destroy_cb_t'>mxml_custom_destroy_cb_t</a> destroy<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node or MXML_NO_PARENT</dd>
|
|
|
|
<dt>data</dt>
|
|
|
|
<dd class='summary'>Pointer to data</dd>
|
|
|
|
<dt>destroy</dt>
|
|
|
|
<dd class='summary'>Function to destroy data</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The new custom node is added to the end of the specified parent's child
|
|
|
|
list. The constant MXML_NO_PARENT can be used to specify that the new
|
|
|
|
element node has no parent. NULL can be passed when the data in the
|
|
|
|
node is not dynamically allocated or is separately managed.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><a name="mxmlNewElement">mxmlNewElement</a></h3>
|
|
|
|
<p class='summary'>Create a new element node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewElement (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
const char *name<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node or MXML_NO_PARENT</dd>
|
|
|
|
<dt>name</dt>
|
|
|
|
<dd class='summary'>Name of element</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The new element node is added to the end of the specified parent's child
|
|
|
|
list. The constant MXML_NO_PARENT can be used to specify that the new
|
|
|
|
element node has no parent.</p>
|
|
|
|
<h3 class='function'><a name="mxmlNewInteger">mxmlNewInteger</a></h3>
|
|
|
|
<p class='summary'>Create a new integer node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewInteger (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
int integer<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node or MXML_NO_PARENT</dd>
|
|
|
|
<dt>integer</dt>
|
|
|
|
<dd class='summary'>Integer value</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The new integer node is added to the end of the specified parent's child
|
|
|
|
list. The constant MXML_NO_PARENT can be used to specify that the new
|
|
|
|
integer node has no parent.</p>
|
|
|
|
<h3 class='function'><a name="mxmlNewOpaque">mxmlNewOpaque</a></h3>
|
|
|
|
<p class='summary'>Create a new opaque string.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewOpaque (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
const char *opaque<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node or MXML_NO_PARENT</dd>
|
|
|
|
<dt>opaque</dt>
|
|
|
|
<dd class='summary'>Opaque string</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The new opaque node is added to the end of the specified parent's child
|
|
|
|
list. The constant MXML_NO_PARENT can be used to specify that the new
|
|
|
|
opaque node has no parent. The opaque string must be nul-terminated and
|
|
|
|
is copied into the new node.</p>
|
|
|
|
<h3 class='function'><a name="mxmlNewReal">mxmlNewReal</a></h3>
|
|
|
|
<p class='summary'>Create a new real number node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewReal (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
double real<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node or MXML_NO_PARENT</dd>
|
|
|
|
<dt>real</dt>
|
|
|
|
<dd class='summary'>Real number value</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The new real number node is added to the end of the specified parent's
|
|
|
|
child list. The constant MXML_NO_PARENT can be used to specify that
|
|
|
|
the new real number node has no parent.</p>
|
|
|
|
<h3 class='function'><a name="mxmlNewText">mxmlNewText</a></h3>
|
|
|
|
<p class='summary'>Create a new text fragment node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewText (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
int whitespace,<br>
|
|
|
|
const char *string<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node or MXML_NO_PARENT</dd>
|
|
|
|
<dt>whitespace</dt>
|
|
|
|
<dd class='summary'>1 = leading whitespace, 0 = no whitespace</dd>
|
|
|
|
<dt>string</dt>
|
|
|
|
<dd class='summary'>String</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The new text node is added to the end of the specified parent's child
|
|
|
|
list. The constant MXML_NO_PARENT can be used to specify that the new
|
|
|
|
text node has no parent. The whitespace parameter is used to specify
|
|
|
|
whether leading whitespace is present before the node. The text
|
|
|
|
string must be nul-terminated and is copied into the new node.</p>
|
|
|
|
<h3 class='function'><a name="mxmlNewTextf">mxmlNewTextf</a></h3>
|
|
|
|
<p class='summary'>Create a new formatted text fragment node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewTextf (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *parent,<br>
|
|
|
|
int whitespace,<br>
|
|
|
|
const char *format,<br>
|
|
|
|
...<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>parent</dt>
|
|
|
|
<dd class='summary'>Parent node or MXML_NO_PARENT</dd>
|
|
|
|
<dt>whitespace</dt>
|
|
|
|
<dd class='summary'>1 = leading whitespace, 0 = no whitespace</dd>
|
|
|
|
<dt>format</dt>
|
|
|
|
<dd class='summary'>Printf-style frmat string</dd>
|
|
|
|
<dt>...</dt>
|
|
|
|
<dd class='summary'>Additional args as needed</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The new text node is added to the end of the specified parent's child
|
|
|
|
list. The constant MXML_NO_PARENT can be used to specify that the new
|
|
|
|
text node has no parent. The whitespace parameter is used to specify
|
|
|
|
whether leading whitespace is present before the node. The format
|
|
|
|
string must be nul-terminated and is formatted into the new node.</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlNewXML">mxmlNewXML</a></h3>
|
|
|
|
<p class='summary'>Create a new XML document tree.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlNewXML (<br>
|
|
|
|
const char *version<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>version</dt>
|
|
|
|
<dd class='summary'>Version number to use</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New ?xml node</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The "version" argument specifies the version number to put in the
|
|
|
|
?xml element node. If NULL, version 1.0 is assumed.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlRelease">mxmlRelease</a></h3>
|
|
|
|
<p class='summary'>Release a node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlRelease (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New reference count</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>When the reference count reaches zero, the node (and any children)
|
|
|
|
is deleted via mxmlDelete().
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><a name="mxmlRemove">mxmlRemove</a></h3>
|
|
|
|
<p class='summary'>Remove a node from its parent.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlRemove (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to remove</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>Does not free memory used by the node - use mxmlDelete() for that.
|
|
|
|
This function does nothing if the node has no parent.</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlRetain">mxmlRetain</a></h3>
|
|
|
|
<p class='summary'>Retain a node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlRetain (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>New reference count</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'></p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlSAXLoadFd">mxmlSAXLoadFd</a></h3>
|
|
|
|
<p class='summary'>Load a file descriptor into an XML node tree
|
|
|
|
using a SAX callback.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlSAXLoadFd (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
int fd,<br>
|
|
|
|
<a href='#mxml_load_cb_t'>mxml_load_cb_t</a> cb,<br>
|
|
|
|
<a href='#mxml_sax_cb_t'>mxml_sax_cb_t</a> sax_cb,<br>
|
|
|
|
void *sax_data<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>fd</dt>
|
|
|
|
<dd class='summary'>File descriptor to read from</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Callback function or MXML_NO_CALLBACK</dd>
|
|
|
|
<dt>sax_cb</dt>
|
|
|
|
<dd class='summary'>SAX callback or MXML_NO_CALLBACK</dd>
|
|
|
|
<dt>sax_data</dt>
|
|
|
|
<dd class='summary'>SAX user data</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>First node or NULL if the file could not be read.</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The nodes in the specified file are added to the specified top node.
|
|
|
|
If no top node is provided, the XML file MUST be well-formed with a
|
|
|
|
single parent node like <?xml> for the entire file. The callback
|
|
|
|
function returns the value type that should be used for child nodes.
|
|
|
|
If MXML_NO_CALLBACK is specified then all child nodes will be either
|
|
|
|
MXML_ELEMENT or MXML_TEXT nodes.<br>
|
|
|
|
<br>
|
|
|
|
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
|
|
|
|
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
|
|
|
|
child nodes of the specified type.<br>
|
|
|
|
<br>
|
|
|
|
The SAX callback must call mxmlRetain() for any nodes that need to
|
|
|
|
be kept for later use. Otherwise, nodes are deleted when the parent
|
|
|
|
node is closed or after each data, comment, CDATA, or directive node.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlSAXLoadFile">mxmlSAXLoadFile</a></h3>
|
|
|
|
<p class='summary'>Load a file into an XML node tree
|
|
|
|
using a SAX callback.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlSAXLoadFile (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
FILE *fp,<br>
|
|
|
|
<a href='#mxml_load_cb_t'>mxml_load_cb_t</a> cb,<br>
|
|
|
|
<a href='#mxml_sax_cb_t'>mxml_sax_cb_t</a> sax_cb,<br>
|
|
|
|
void *sax_data<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>fp</dt>
|
|
|
|
<dd class='summary'>File to read from</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Callback function or MXML_NO_CALLBACK</dd>
|
|
|
|
<dt>sax_cb</dt>
|
|
|
|
<dd class='summary'>SAX callback or MXML_NO_CALLBACK</dd>
|
|
|
|
<dt>sax_data</dt>
|
|
|
|
<dd class='summary'>SAX user data</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>First node or NULL if the file could not be read.</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The nodes in the specified file are added to the specified top node.
|
|
|
|
If no top node is provided, the XML file MUST be well-formed with a
|
|
|
|
single parent node like <?xml> for the entire file. The callback
|
|
|
|
function returns the value type that should be used for child nodes.
|
|
|
|
If MXML_NO_CALLBACK is specified then all child nodes will be either
|
|
|
|
MXML_ELEMENT or MXML_TEXT nodes.<br>
|
|
|
|
<br>
|
|
|
|
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
|
|
|
|
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
|
|
|
|
child nodes of the specified type.<br>
|
|
|
|
<br>
|
|
|
|
The SAX callback must call mxmlRetain() for any nodes that need to
|
|
|
|
be kept for later use. Otherwise, nodes are deleted when the parent
|
|
|
|
node is closed or after each data, comment, CDATA, or directive node.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlSAXLoadString">mxmlSAXLoadString</a></h3>
|
|
|
|
<p class='summary'>Load a string into an XML node tree
|
|
|
|
using a SAX callback.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlSAXLoadString (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
const char *s,<br>
|
|
|
|
<a href='#mxml_load_cb_t'>mxml_load_cb_t</a> cb,<br>
|
|
|
|
<a href='#mxml_sax_cb_t'>mxml_sax_cb_t</a> sax_cb,<br>
|
|
|
|
void *sax_data<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>s</dt>
|
|
|
|
<dd class='summary'>String to load</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Callback function or MXML_NO_CALLBACK</dd>
|
|
|
|
<dt>sax_cb</dt>
|
|
|
|
<dd class='summary'>SAX callback or MXML_NO_CALLBACK</dd>
|
|
|
|
<dt>sax_data</dt>
|
|
|
|
<dd class='summary'>SAX user data</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>First node or NULL if the string has errors.</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The nodes in the specified string are added to the specified top node.
|
|
|
|
If no top node is provided, the XML string MUST be well-formed with a
|
|
|
|
single parent node like <?xml> for the entire string. The callback
|
|
|
|
function returns the value type that should be used for child nodes.
|
|
|
|
If MXML_NO_CALLBACK is specified then all child nodes will be either
|
|
|
|
MXML_ELEMENT or MXML_TEXT nodes.<br>
|
|
|
|
<br>
|
|
|
|
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
|
|
|
|
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
|
|
|
|
child nodes of the specified type.<br>
|
|
|
|
<br>
|
|
|
|
The SAX callback must call mxmlRetain() for any nodes that need to
|
|
|
|
be kept for later use. Otherwise, nodes are deleted when the parent
|
|
|
|
node is closed or after each data, comment, CDATA, or directive node.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><a name="mxmlSaveAllocString">mxmlSaveAllocString</a></h3>
|
|
|
|
<p class='summary'>Save an XML node tree to an allocated string.</p>
|
|
|
|
<p class='code'>
|
|
|
|
char *mxmlSaveAllocString (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
<a href='#mxml_save_cb_t'>mxml_save_cb_t</a> cb<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to write</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Whitespace callback or MXML_NO_CALLBACK</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Allocated string or NULL</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>This function returns a pointer to a string containing the textual
|
|
|
|
representation of the XML node tree. The string should be freed
|
|
|
|
using the free() function when you are done with it. NULL is returned
|
|
|
|
if the node would produce an empty string or if the string cannot be
|
|
|
|
allocated.<br>
|
|
|
|
<br>
|
|
|
|
The callback argument specifies a function that returns a whitespace
|
|
|
|
string or NULL before and after each element. If MXML_NO_CALLBACK
|
|
|
|
is specified, whitespace will only be added before MXML_TEXT nodes
|
|
|
|
with leading whitespace and before attribute names inside opening
|
|
|
|
element tags.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSaveFd">mxmlSaveFd</a></h3>
|
|
|
|
<p class='summary'>Save an XML tree to a file descriptor.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSaveFd (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
int fd,<br>
|
|
|
|
<a href='#mxml_save_cb_t'>mxml_save_cb_t</a> cb<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to write</dd>
|
|
|
|
<dt>fd</dt>
|
|
|
|
<dd class='summary'>File descriptor to write to</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Whitespace callback or MXML_NO_CALLBACK</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on error.</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The callback argument specifies a function that returns a whitespace
|
|
|
|
string or NULL before and after each element. If MXML_NO_CALLBACK
|
|
|
|
is specified, whitespace will only be added before MXML_TEXT nodes
|
|
|
|
with leading whitespace and before attribute names inside opening
|
|
|
|
element tags.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSaveFile">mxmlSaveFile</a></h3>
|
|
|
|
<p class='summary'>Save an XML tree to a file.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSaveFile (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
FILE *fp,<br>
|
|
|
|
<a href='#mxml_save_cb_t'>mxml_save_cb_t</a> cb<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to write</dd>
|
|
|
|
<dt>fp</dt>
|
|
|
|
<dd class='summary'>File to write to</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Whitespace callback or MXML_NO_CALLBACK</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on error.</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The callback argument specifies a function that returns a whitespace
|
|
|
|
string or NULL before and after each element. If MXML_NO_CALLBACK
|
|
|
|
is specified, whitespace will only be added before MXML_TEXT nodes
|
|
|
|
with leading whitespace and before attribute names inside opening
|
|
|
|
element tags.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSaveString">mxmlSaveString</a></h3>
|
|
|
|
<p class='summary'>Save an XML node tree to a string.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSaveString (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
char *buffer,<br>
|
|
|
|
int bufsize,<br>
|
|
|
|
<a href='#mxml_save_cb_t'>mxml_save_cb_t</a> cb<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to write</dd>
|
|
|
|
<dt>buffer</dt>
|
|
|
|
<dd class='summary'>String buffer</dd>
|
|
|
|
<dt>bufsize</dt>
|
|
|
|
<dd class='summary'>Size of string buffer</dd>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Whitespace callback or MXML_NO_CALLBACK</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Size of string</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>This function returns the total number of bytes that would be
|
|
|
|
required for the string but only copies (bufsize - 1) characters
|
|
|
|
into the specified buffer.<br>
|
|
|
|
<br>
|
|
|
|
The callback argument specifies a function that returns a whitespace
|
|
|
|
string or NULL before and after each element. If MXML_NO_CALLBACK
|
|
|
|
is specified, whitespace will only be added before MXML_TEXT nodes
|
|
|
|
with leading whitespace and before attribute names inside opening
|
|
|
|
element tags.</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlSetCDATA">mxmlSetCDATA</a></h3>
|
|
|
|
<p class='summary'>Set the element name of a CDATA node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSetCDATA (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
const char *data<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to set</dd>
|
|
|
|
<dt>data</dt>
|
|
|
|
<dd class='summary'>New data string</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The node is not changed if it is not a CDATA element node.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.1 </span><a name="mxmlSetCustom">mxmlSetCustom</a></h3>
|
|
|
|
<p class='summary'>Set the data and destructor of a custom data node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSetCustom (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
void *data,<br>
|
|
|
|
<a href='#mxml_custom_destroy_cb_t'>mxml_custom_destroy_cb_t</a> destroy<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to set</dd>
|
|
|
|
<dt>data</dt>
|
|
|
|
<dd class='summary'>New data pointer</dd>
|
|
|
|
<dt>destroy</dt>
|
|
|
|
<dd class='summary'>New destructor function</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The node is not changed if it is not a custom node.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><a name="mxmlSetCustomHandlers">mxmlSetCustomHandlers</a></h3>
|
|
|
|
<p class='summary'>Set the handling functions for custom data.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlSetCustomHandlers (<br>
|
|
|
|
<a href='#mxml_custom_load_cb_t'>mxml_custom_load_cb_t</a> load,<br>
|
|
|
|
<a href='#mxml_custom_save_cb_t'>mxml_custom_save_cb_t</a> save<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>load</dt>
|
|
|
|
<dd class='summary'>Load function</dd>
|
|
|
|
<dt>save</dt>
|
|
|
|
<dd class='summary'>Save function</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The load function accepts a node pointer and a data string and must
|
|
|
|
return 0 on success and non-zero on error.<br>
|
|
|
|
<br>
|
|
|
|
The save function accepts a node pointer and must return a malloc'd
|
|
|
|
string on success and NULL on error.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSetElement">mxmlSetElement</a></h3>
|
|
|
|
<p class='summary'>Set the name of an element node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSetElement (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
const char *name<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to set</dd>
|
|
|
|
<dt>name</dt>
|
|
|
|
<dd class='summary'>New name string</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The node is not changed if it is not an element node.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSetErrorCallback">mxmlSetErrorCallback</a></h3>
|
|
|
|
<p class='summary'>Set the error message callback.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlSetErrorCallback (<br>
|
|
|
|
<a href='#mxml_error_cb_t'>mxml_error_cb_t</a> cb<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>cb</dt>
|
|
|
|
<dd class='summary'>Error callback function</dd>
|
|
|
|
</dl>
|
|
|
|
<h3 class='function'><a name="mxmlSetInteger">mxmlSetInteger</a></h3>
|
|
|
|
<p class='summary'>Set the value of an integer node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSetInteger (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
int integer<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to set</dd>
|
|
|
|
<dt>integer</dt>
|
|
|
|
<dd class='summary'>Integer value</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The node is not changed if it is not an integer node.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSetOpaque">mxmlSetOpaque</a></h3>
|
|
|
|
<p class='summary'>Set the value of an opaque node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSetOpaque (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
const char *opaque<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to set</dd>
|
|
|
|
<dt>opaque</dt>
|
|
|
|
<dd class='summary'>Opaque string</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The node is not changed if it is not an opaque node.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSetReal">mxmlSetReal</a></h3>
|
|
|
|
<p class='summary'>Set the value of a real number node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSetReal (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
double real<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to set</dd>
|
|
|
|
<dt>real</dt>
|
|
|
|
<dd class='summary'>Real number value</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The node is not changed if it is not a real number node.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSetText">mxmlSetText</a></h3>
|
|
|
|
<p class='summary'>Set the value of a text node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSetText (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
int whitespace,<br>
|
|
|
|
const char *string<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to set</dd>
|
|
|
|
<dt>whitespace</dt>
|
|
|
|
<dd class='summary'>1 = leading whitespace, 0 = no whitespace</dd>
|
|
|
|
<dt>string</dt>
|
|
|
|
<dd class='summary'>String</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The node is not changed if it is not a text node.</p>
|
|
|
|
<h3 class='function'><a name="mxmlSetTextf">mxmlSetTextf</a></h3>
|
|
|
|
<p class='summary'>Set the value of a text node to a formatted string.</p>
|
|
|
|
<p class='code'>
|
|
|
|
int mxmlSetTextf (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
int whitespace,<br>
|
|
|
|
const char *format,<br>
|
|
|
|
...<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Node to set</dd>
|
|
|
|
<dt>whitespace</dt>
|
|
|
|
<dd class='summary'>1 = leading whitespace, 0 = no whitespace</dd>
|
|
|
|
<dt>format</dt>
|
|
|
|
<dd class='summary'>Printf-style format string</dd>
|
|
|
|
<dt>...</dt>
|
|
|
|
<dd class='summary'>Additional arguments as needed</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>0 on success, -1 on failure</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The node is not changed if it is not a text node.</p>
|
|
|
|
<h3 class='function'><span class='info'> Mini-XML 2.3 </span><a name="mxmlSetWrapMargin">mxmlSetWrapMargin</a></h3>
|
|
|
|
<p class='summary'>Set the the wrap margin when saving XML data.</p>
|
|
|
|
<p class='code'>
|
|
|
|
void mxmlSetWrapMargin (<br>
|
|
|
|
int column<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>column</dt>
|
|
|
|
<dd class='summary'>Column for wrapping</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>Wrapping is disabled when "column" is <= 0.
|
|
|
|
|
|
|
|
</p>
|
|
|
|
<h3 class='function'><a name="mxmlWalkNext">mxmlWalkNext</a></h3>
|
|
|
|
<p class='summary'>Walk to the next logical node in the tree.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlWalkNext (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
int descend<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Current node</dd>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>descend</dt>
|
|
|
|
<dd class='summary'>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Next node or NULL</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The descend argument controls whether the first child is considered
|
|
|
|
to be the next node. The top node argument constrains the walk to
|
|
|
|
the node's children.</p>
|
|
|
|
<h3 class='function'><a name="mxmlWalkPrev">mxmlWalkPrev</a></h3>
|
|
|
|
<p class='summary'>Walk to the previous logical node in the tree.</p>
|
|
|
|
<p class='code'>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *mxmlWalkPrev (<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *node,<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> *top,<br>
|
|
|
|
int descend<br>
|
|
|
|
);</p>
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>node</dt>
|
|
|
|
<dd class='summary'>Current node</dd>
|
|
|
|
<dt>top</dt>
|
|
|
|
<dd class='summary'>Top node</dd>
|
|
|
|
<dt>descend</dt>
|
|
|
|
<dd class='summary'>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</dd>
|
|
|
|
</dl>
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<p class='summary'>Previous node or NULL</p>
|
|
|
|
<h4>Discussion</h4>
|
|
|
|
<p class='discussion'>The descend argument controls whether the previous node's last child
|
|
|
|
is considered to be the previous node. The top node argument constrains
|
|
|
|
the walk to the node's children.</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h2 class='title'><a name='TYPES'>Data Types</a></h2>
|
|
|
|
<ul class='code'>
|
|
|
|
<li><a href='#mxml_attr_t'>mxml_attr_t</a> </li>
|
|
|
|
<li><a href='#mxml_custom_destroy_cb_t'>mxml_custom_destroy_cb_t</a> </li>
|
|
|
|
<li><a href='#mxml_custom_load_cb_t'>mxml_custom_load_cb_t</a> </li>
|
|
|
|
<li><a href='#mxml_custom_save_cb_t'>mxml_custom_save_cb_t</a> </li>
|
|
|
|
<li><a href='#mxml_custom_t'>mxml_custom_t</a> <span class='info'> Mini-XML 2.1 </span></li>
|
|
|
|
<li><a href='#mxml_element_t'>mxml_element_t</a> </li>
|
|
|
|
<li><a href='#mxml_error_cb_t'>mxml_error_cb_t</a> </li>
|
|
|
|
<li><a href='#mxml_index_t'>mxml_index_t</a> </li>
|
|
|
|
<li><a href='#mxml_load_cb_t'>mxml_load_cb_t</a> </li>
|
|
|
|
<li><a href='#mxml_node_t'>mxml_node_t</a> </li>
|
|
|
|
<li><a href='#mxml_save_cb_t'>mxml_save_cb_t</a> </li>
|
|
|
|
<li><a href='#mxml_sax_cb_t'>mxml_sax_cb_t</a> </li>
|
|
|
|
<li><a href='#mxml_sax_event_t'>mxml_sax_event_t</a> </li>
|
|
|
|
<li><a href='#mxml_text_t'>mxml_text_t</a> </li>
|
|
|
|
<li><a href='#mxml_value_t'>mxml_value_t</a> </li>
|
|
|
|
</ul>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_attr_t'>mxml_attr_t</a></h3>
|
|
|
|
<p class='summary'>An XML element attribute value.</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef struct <a href='#mxml_attr_s'>mxml_attr_s</a> mxml_attr_t;
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_custom_destroy_cb_t'>mxml_custom_destroy_cb_t</a></h3>
|
|
|
|
<p class='summary'>Custom data destructor</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef void (*mxml_custom_destroy_cb_t)(void *);
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_custom_load_cb_t'>mxml_custom_load_cb_t</a></h3>
|
|
|
|
<p class='summary'>Custom data load callback function</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef int (*mxml_custom_load_cb_t)(<a href='#mxml_node_t'>mxml_node_t</a> *, const char *);
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_custom_save_cb_t'>mxml_custom_save_cb_t</a></h3>
|
|
|
|
<p class='summary'>Custom data save callback function</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef char *(*mxml_custom_save_cb_t)(<a href='#mxml_node_t'>mxml_node_t</a> *);
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><span class='info'> Mini-XML 2.1 </span><a name='mxml_custom_t'>mxml_custom_t</a></h3>
|
|
|
|
<p class='summary'>An XML custom value. </p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef struct <a href='#mxml_custom_s'>mxml_custom_s</a> mxml_custom_t;
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_element_t'>mxml_element_t</a></h3>
|
|
|
|
<p class='summary'>An XML element value.</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef struct <a href='#mxml_element_s'>mxml_element_s</a> mxml_element_t;
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_error_cb_t'>mxml_error_cb_t</a></h3>
|
|
|
|
<p class='summary'>Error callback function</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef void (*mxml_error_cb_t)(const char *);
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_index_t'>mxml_index_t</a></h3>
|
|
|
|
<p class='summary'>An XML node index.</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef struct <a href='#mxml_index_s'>mxml_index_s</a> mxml_index_t;
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_load_cb_t'>mxml_load_cb_t</a></h3>
|
|
|
|
<p class='summary'>Load callback function</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef mxml_type_t (*mxml_load_cb_t)(<a href='#mxml_node_t'>mxml_node_t</a> *);
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_node_t'>mxml_node_t</a></h3>
|
|
|
|
<p class='summary'>An XML node.</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef struct <a href='#mxml_node_s'>mxml_node_s</a> mxml_node_t;
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_save_cb_t'>mxml_save_cb_t</a></h3>
|
|
|
|
<p class='summary'>Save callback function</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef const char *(*mxml_save_cb_t)(<a href='#mxml_node_t'>mxml_node_t</a> *, int);
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_sax_cb_t'>mxml_sax_cb_t</a></h3>
|
|
|
|
<p class='summary'>SAX callback function</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef void (*mxml_sax_cb_t)(<a href='#mxml_node_t'>mxml_node_t</a> *, mxml_sax_event_t, void *);
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_sax_event_t'>mxml_sax_event_t</a></h3>
|
|
|
|
<p class='summary'>SAX event type.</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef enum <a href='#mxml_sax_event_e'>mxml_sax_event_e</a> mxml_sax_event_t;
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_text_t'>mxml_text_t</a></h3>
|
|
|
|
<p class='summary'>An XML text value.</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef struct <a href='#mxml_text_s'>mxml_text_s</a> mxml_text_t;
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_value_t'>mxml_value_t</a></h3>
|
|
|
|
<p class='summary'>An XML node value.</p>
|
|
|
|
<p class='code'>
|
|
|
|
typedef union <a href='#mxml_value_u'>mxml_value_u</a> mxml_value_t;
|
|
|
|
</p>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h2 class='title'><a name='STRUCTURES'>Structures</a></h2>
|
|
|
|
<ul class='code'>
|
|
|
|
<li><a href='#mxml_attr_s'>mxml_attr_s</a> </li>
|
|
|
|
<li><a href='#mxml_custom_s'>mxml_custom_s</a> <span class='info'> Mini-XML 2.1 </span></li>
|
|
|
|
<li><a href='#mxml_element_s'>mxml_element_s</a> </li>
|
|
|
|
<li><a href='#mxml_index_s'>mxml_index_s</a> </li>
|
|
|
|
<li><a href='#mxml_node_s'>mxml_node_s</a> </li>
|
|
|
|
<li><a href='#mxml_text_s'>mxml_text_s</a> </li>
|
|
|
|
</ul>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_attr_s'>mxml_attr_s</a></h3>
|
|
|
|
<p class='summary'>An XML element attribute value.</p>
|
|
|
|
<h4>Definition</h4>
|
|
|
|
<p class='code'>struct mxml_attr_s {<br>
|
|
|
|
char *name;<br>
|
|
|
|
char *value;<br>
|
|
|
|
};</p>
|
|
|
|
<h4>Members</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>name </dt>
|
|
|
|
<dd class='summary'>Attribute name</dd>
|
|
|
|
<dt>value </dt>
|
|
|
|
<dd class='summary'>Attribute value</dd>
|
|
|
|
</dl>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><span class='info'> Mini-XML 2.1 </span><a name='mxml_custom_s'>mxml_custom_s</a></h3>
|
|
|
|
<p class='summary'>An XML custom value. </p>
|
|
|
|
<h4>Definition</h4>
|
|
|
|
<p class='code'>struct mxml_custom_s {<br>
|
|
|
|
void *data;<br>
|
|
|
|
<a href='#mxml_custom_destroy_cb_t'>mxml_custom_destroy_cb_t</a> destroy;<br>
|
|
|
|
};</p>
|
|
|
|
<h4>Members</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>data </dt>
|
|
|
|
<dd class='summary'>Pointer to (allocated) custom data</dd>
|
|
|
|
<dt>destroy </dt>
|
|
|
|
<dd class='summary'>Pointer to destructor function</dd>
|
|
|
|
</dl>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_element_s'>mxml_element_s</a></h3>
|
|
|
|
<p class='summary'>An XML element value.</p>
|
|
|
|
<h4>Definition</h4>
|
|
|
|
<p class='code'>struct mxml_element_s {<br>
|
|
|
|
<a href='#mxml_attr_t'>mxml_attr_t</a> *attrs;<br>
|
|
|
|
char *name;<br>
|
|
|
|
int num_attrs;<br>
|
|
|
|
};</p>
|
|
|
|
<h4>Members</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>attrs </dt>
|
|
|
|
<dd class='summary'>Attributes</dd>
|
|
|
|
<dt>name </dt>
|
|
|
|
<dd class='summary'>Name of element</dd>
|
|
|
|
<dt>num_attrs </dt>
|
|
|
|
<dd class='summary'>Number of attributes</dd>
|
|
|
|
</dl>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_index_s'>mxml_index_s</a></h3>
|
|
|
|
<p class='summary'>An XML node index.</p>
|
|
|
|
<h4>Definition</h4>
|
|
|
|
<p class='code'>struct mxml_index_s {<br>
|
|
|
|
int alloc_nodes;<br>
|
|
|
|
char *attr;<br>
|
|
|
|
int cur_node;<br>
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> **nodes;<br>
|
|
|
|
int num_nodes;<br>
|
|
|
|
};</p>
|
|
|
|
<h4>Members</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>alloc_nodes </dt>
|
|
|
|
<dd class='summary'>Allocated nodes in index</dd>
|
|
|
|
<dt>attr </dt>
|
|
|
|
<dd class='summary'>Attribute used for indexing or NULL</dd>
|
|
|
|
<dt>cur_node </dt>
|
|
|
|
<dd class='summary'>Current node</dd>
|
|
|
|
<dt>nodes </dt>
|
|
|
|
<dd class='summary'>Node array</dd>
|
|
|
|
<dt>num_nodes </dt>
|
|
|
|
<dd class='summary'>Number of nodes in index</dd>
|
|
|
|
</dl>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_node_s'>mxml_node_s</a></h3>
|
|
|
|
<p class='summary'>An XML node.</p>
|
|
|
|
<h4>Definition</h4>
|
|
|
|
<p class='code'>struct mxml_node_s {<br>
|
|
|
|
struct <a href='#mxml_node_s'>mxml_node_s</a> *child;<br>
|
|
|
|
struct <a href='#mxml_node_s'>mxml_node_s</a> *last_child;<br>
|
|
|
|
struct <a href='#mxml_node_s'>mxml_node_s</a> *next;<br>
|
|
|
|
struct <a href='#mxml_node_s'>mxml_node_s</a> *parent;<br>
|
|
|
|
struct <a href='#mxml_node_s'>mxml_node_s</a> *prev;<br>
|
|
|
|
int ref_count;<br>
|
|
|
|
mxml_type_t type;<br>
|
|
|
|
void *user_data;<br>
|
|
|
|
<a href='#mxml_value_t'>mxml_value_t</a> value;<br>
|
|
|
|
};</p>
|
|
|
|
<h4>Members</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>child </dt>
|
|
|
|
<dd class='summary'>First child node</dd>
|
|
|
|
<dt>last_child </dt>
|
|
|
|
<dd class='summary'>Last child node</dd>
|
|
|
|
<dt>next </dt>
|
|
|
|
<dd class='summary'>Next node under same parent</dd>
|
|
|
|
<dt>parent </dt>
|
|
|
|
<dd class='summary'>Parent node</dd>
|
|
|
|
<dt>prev </dt>
|
|
|
|
<dd class='summary'>Previous node under same parent</dd>
|
|
|
|
<dt>ref_count </dt>
|
|
|
|
<dd class='summary'>Use count</dd>
|
|
|
|
<dt>type </dt>
|
|
|
|
<dd class='summary'>Node type</dd>
|
|
|
|
<dt>user_data </dt>
|
|
|
|
<dd class='summary'>User data</dd>
|
|
|
|
<dt>value </dt>
|
|
|
|
<dd class='summary'>Node value</dd>
|
|
|
|
</dl>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_text_s'>mxml_text_s</a></h3>
|
|
|
|
<p class='summary'>An XML text value.</p>
|
|
|
|
<h4>Definition</h4>
|
|
|
|
<p class='code'>struct mxml_text_s {<br>
|
|
|
|
char *string;<br>
|
|
|
|
int whitespace;<br>
|
|
|
|
};</p>
|
|
|
|
<h4>Members</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>string </dt>
|
|
|
|
<dd class='summary'>Fragment string</dd>
|
|
|
|
<dt>whitespace </dt>
|
|
|
|
<dd class='summary'>Leading whitespace?</dd>
|
|
|
|
</dl>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h2 class='title'><a name='UNIONS'>Unions</a></h2>
|
|
|
|
<ul class='code'>
|
|
|
|
<li><a href='#mxml_value_u'>mxml_value_u</a> </li>
|
|
|
|
</ul>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_value_u'>mxml_value_u</a></h3>
|
|
|
|
<p class='summary'>An XML node value.</p>
|
|
|
|
<p class='code'>union mxml_value_u {<br>
|
|
|
|
<a href='#mxml_custom_t'>mxml_custom_t</a> custom;<br>
|
|
|
|
<a href='#mxml_element_t'>mxml_element_t</a> element;<br>
|
|
|
|
int integer;<br>
|
|
|
|
char *opaque;<br>
|
|
|
|
double real;<br>
|
|
|
|
<a href='#mxml_text_t'>mxml_text_t</a> text;<br>
|
|
|
|
};</p>
|
|
|
|
<h4>Members</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>custom <span class='info'> Mini-XML 2.1 </span></dt>
|
|
|
|
<dd class='summary'>Custom data </dd>
|
|
|
|
<dt>element </dt>
|
|
|
|
<dd class='summary'>Element</dd>
|
|
|
|
<dt>integer </dt>
|
|
|
|
<dd class='summary'>Integer number</dd>
|
|
|
|
<dt>opaque </dt>
|
|
|
|
<dd class='summary'>Opaque string</dd>
|
|
|
|
<dt>real </dt>
|
|
|
|
<dd class='summary'>Real number</dd>
|
|
|
|
<dt>text </dt>
|
|
|
|
<dd class='summary'>Text fragment</dd>
|
|
|
|
</dl>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h2 class='title'><a name='ENUMERATIONS'>Constants</a></h2>
|
|
|
|
<ul class='code'>
|
|
|
|
<li><a href='#mxml_sax_event_e'>mxml_sax_event_e</a> </li>
|
|
|
|
<li><a href='#mxml_type_e'>mxml_type_e</a> </li>
|
|
|
|
</ul>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_sax_event_e'>mxml_sax_event_e</a></h3>
|
|
|
|
<p class='summary'>SAX event type.</p>
|
|
|
|
<h4>Constants</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>MXML_SAX_CDATA </dt>
|
|
|
|
<dd class='summary'>CDATA node</dd>
|
|
|
|
<dt>MXML_SAX_COMMENT </dt>
|
|
|
|
<dd class='summary'>Comment node</dd>
|
|
|
|
<dt>MXML_SAX_DATA </dt>
|
|
|
|
<dd class='summary'>Data node</dd>
|
|
|
|
<dt>MXML_SAX_DIRECTIVE </dt>
|
|
|
|
<dd class='summary'>Processing directive node</dd>
|
|
|
|
<dt>MXML_SAX_ELEMENT_CLOSE </dt>
|
|
|
|
<dd class='summary'>Element closed</dd>
|
|
|
|
<dt>MXML_SAX_ELEMENT_OPEN </dt>
|
|
|
|
<dd class='summary'>Element opened</dd>
|
|
|
|
</dl>
|
|
|
|
<!-- NEW PAGE -->
|
|
|
|
<h3><a name='mxml_type_e'>mxml_type_e</a></h3>
|
|
|
|
<p class='summary'>The XML node type.</p>
|
|
|
|
<h4>Constants</h4>
|
|
|
|
<dl>
|
|
|
|
<dt>MXML_CUSTOM <span class='info'> Mini-XML 2.1 </span></dt>
|
|
|
|
<dd class='summary'>Custom data </dd>
|
|
|
|
<dt>MXML_ELEMENT </dt>
|
|
|
|
<dd class='summary'>XML element with attributes</dd>
|
|
|
|
<dt>MXML_IGNORE <span class='info'> Mini-XML 2.3 </span></dt>
|
|
|
|
<dd class='summary'>Ignore/throw away node </dd>
|
|
|
|
<dt>MXML_INTEGER </dt>
|
|
|
|
<dd class='summary'>Integer value</dd>
|
|
|
|
<dt>MXML_OPAQUE </dt>
|
|
|
|
<dd class='summary'>Opaque string</dd>
|
|
|
|
<dt>MXML_REAL </dt>
|
|
|
|
<dd class='summary'>Real value</dd>
|
|
|
|
<dt>MXML_TEXT </dt>
|
|
|
|
<dd class='summary'>Text fragment</dd>
|
|
|
|
</dl>
|
|
|
|
</body>
|
|
|
|
</html>
|