|
|
|
|
@ -2,7 +2,7 @@ |
|
|
|
|
<html> |
|
|
|
|
<head> |
|
|
|
|
<title>Documentation</title> |
|
|
|
|
<meta name='creator' content='Mini-XML v2.3'> |
|
|
|
|
<meta name='creator' content='Mini-XML v2.4'> |
|
|
|
|
<style type='text/css'><!-- |
|
|
|
|
h1, h2, h3, p { font-family: sans-serif; text-align: justify; } |
|
|
|
|
tt, pre a:link, pre a:visited, tt a:link, tt a:visited { font-weight: bold; color: #7f0000; } |
|
|
|
|
@ -70,7 +70,9 @@ |
|
|
|
|
<li><a href='#mxmlNewReal'><tt>mxmlNewReal()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlNewText'><tt>mxmlNewText()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlNewTextf'><tt>mxmlNewTextf()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlRelease'><tt>mxmlRelease()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlRemove'><tt>mxmlRemove()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlRetain'><tt>mxmlRetain()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlSaveAllocString'><tt>mxmlSaveAllocString()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlSaveFd'><tt>mxmlSaveFd()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlSaveFile'><tt>mxmlSaveFile()</tt></a> </li> |
|
|
|
|
@ -85,6 +87,7 @@ |
|
|
|
|
<li><a href='#mxmlSetReal'><tt>mxmlSetReal()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlSetText'><tt>mxmlSetText()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlSetTextf'><tt>mxmlSetTextf()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlSetWrapMargin'><tt>mxmlSetWrapMargin()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlWalkNext'><tt>mxmlWalkNext()</tt></a> </li> |
|
|
|
|
<li><a href='#mxmlWalkPrev'><tt>mxmlWalkPrev()</tt></a> </li> |
|
|
|
|
</ul> |
|
|
|
|
@ -712,6 +715,27 @@ mxmlNewTextf( |
|
|
|
|
<h4>Returns</h4> |
|
|
|
|
<p>New node</p> |
|
|
|
|
<!-- NEW PAGE --> |
|
|
|
|
<h3 class='title'><a name='mxmlRelease'>mxmlRelease()</a></h3> |
|
|
|
|
<h4>Description</h4> |
|
|
|
|
<p>Release a node. |
|
|
|
|
|
|
|
|
|
When the reference count reaches zero, the node (and any children) |
|
|
|
|
is deleted via mxmlDelete().</p> |
|
|
|
|
<h4>Syntax</h4> |
|
|
|
|
<pre> |
|
|
|
|
int |
|
|
|
|
mxmlRelease( |
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> * node); |
|
|
|
|
</pre> |
|
|
|
|
<h4>Arguments</h4> |
|
|
|
|
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'> |
|
|
|
|
<thead><tr><th>Name</th><th>Description</th></tr></thead> |
|
|
|
|
<tbody> |
|
|
|
|
<tr><td><tt>node</tt></td><td>Node</td></tr> |
|
|
|
|
</tbody></table></div> |
|
|
|
|
<h4>Returns</h4> |
|
|
|
|
<p>New reference count</p> |
|
|
|
|
<!-- NEW PAGE --> |
|
|
|
|
<h3 class='title'><a name='mxmlRemove'>mxmlRemove()</a></h3> |
|
|
|
|
<h4>Description</h4> |
|
|
|
|
<p>Remove a node from its parent. |
|
|
|
|
@ -733,6 +757,24 @@ mxmlRemove( |
|
|
|
|
<h4>Returns</h4> |
|
|
|
|
<p>Nothing.</p> |
|
|
|
|
<!-- NEW PAGE --> |
|
|
|
|
<h3 class='title'><a name='mxmlRetain'>mxmlRetain()</a></h3> |
|
|
|
|
<h4>Description</h4> |
|
|
|
|
<p>Retain a node.</p> |
|
|
|
|
<h4>Syntax</h4> |
|
|
|
|
<pre> |
|
|
|
|
int |
|
|
|
|
mxmlRetain( |
|
|
|
|
<a href='#mxml_node_t'>mxml_node_t</a> * node); |
|
|
|
|
</pre> |
|
|
|
|
<h4>Arguments</h4> |
|
|
|
|
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'> |
|
|
|
|
<thead><tr><th>Name</th><th>Description</th></tr></thead> |
|
|
|
|
<tbody> |
|
|
|
|
<tr><td><tt>node</tt></td><td>Node</td></tr> |
|
|
|
|
</tbody></table></div> |
|
|
|
|
<h4>Returns</h4> |
|
|
|
|
<p>New reference count</p> |
|
|
|
|
<!-- NEW PAGE --> |
|
|
|
|
<h3 class='title'><a name='mxmlSaveAllocString'>mxmlSaveAllocString()</a></h3> |
|
|
|
|
<h4>Description</h4> |
|
|
|
|
<p>Save an XML node tree to an allocated string. |
|
|
|
|
@ -1072,6 +1114,26 @@ mxmlSetTextf( |
|
|
|
|
<h4>Returns</h4> |
|
|
|
|
<p>0 on success, -1 on failure</p> |
|
|
|
|
<!-- NEW PAGE --> |
|
|
|
|
<h3 class='title'><a name='mxmlSetWrapMargin'>mxmlSetWrapMargin()</a></h3> |
|
|
|
|
<h4>Description</h4> |
|
|
|
|
<p>Set the the wrap margin when saving XML data. |
|
|
|
|
|
|
|
|
|
Wrapping is disabled when "column" is <= 0.</p> |
|
|
|
|
<h4>Syntax</h4> |
|
|
|
|
<pre> |
|
|
|
|
void |
|
|
|
|
mxmlSetWrapMargin( |
|
|
|
|
int column); |
|
|
|
|
</pre> |
|
|
|
|
<h4>Arguments</h4> |
|
|
|
|
<div class='table'><table align='center' border='1' width='80%' cellpadding='5' cellspacing='0'> |
|
|
|
|
<thead><tr><th>Name</th><th>Description</th></tr></thead> |
|
|
|
|
<tbody> |
|
|
|
|
<tr><td><tt>column</tt></td><td>Column for wrapping</td></tr> |
|
|
|
|
</tbody></table></div> |
|
|
|
|
<h4>Returns</h4> |
|
|
|
|
<p>Nothing.</p> |
|
|
|
|
<!-- NEW PAGE --> |
|
|
|
|
<h3 class='title'><a name='mxmlWalkNext'>mxmlWalkNext()</a></h3> |
|
|
|
|
<h4>Description</h4> |
|
|
|
|
<p>Walk to the next logical node in the tree. |
|
|
|
|
@ -1228,7 +1290,9 @@ struct mxml_node_s |
|
|
|
|
struct <a href='#mxml_node_s'>mxml_node_s</a> * next; |
|
|
|
|
struct <a href='#mxml_node_s'>mxml_node_s</a> * parent; |
|
|
|
|
struct <a href='#mxml_node_s'>mxml_node_s</a> * prev; |
|
|
|
|
int ref_count; |
|
|
|
|
mxml_type_t type; |
|
|
|
|
void * user_data; |
|
|
|
|
<a href='#mxml_value_t'>mxml_value_t</a> value; |
|
|
|
|
}; |
|
|
|
|
</pre> |
|
|
|
|
@ -1241,7 +1305,9 @@ struct mxml_node_s |
|
|
|
|
<tr><td><tt>next</tt> </td><td>Next node under same parent</td></tr> |
|
|
|
|
<tr><td><tt>parent</tt> </td><td>Parent node</td></tr> |
|
|
|
|
<tr><td><tt>prev</tt> </td><td>Previous node under same parent</td></tr> |
|
|
|
|
<tr><td><tt>ref_count</tt> </td><td>Use count</td></tr> |
|
|
|
|
<tr><td><tt>type</tt> </td><td>Node type</td></tr> |
|
|
|
|
<tr><td><tt>user_data</tt> </td><td>User data</td></tr> |
|
|
|
|
<tr><td><tt>value</tt> </td><td>Node value</td></tr> |
|
|
|
|
</tbody></table></div> |
|
|
|
|
<!-- NEW PAGE --> |
|
|
|
|
|
Michael R Sweet
18 years ago