mirror of
https://github.com/michaelrsweet/mxml.git
synced 2024-11-24 11:25:30 +00:00
Clean up documentation/HTML errors.
This commit is contained in:
Michael Sweet
parent
923dc965b9
commit
6b1309a1bf
@ -1,6 +1,6 @@
|
||||
<h1>Mini-XML API Reference</h1>
|
||||
|
||||
<div class='summary'><table summary='General Information'>
|
||||
<div class='summary'><table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Header</th>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
|
||||
<h2 class="title"><a id="INTRODUCTION">Introduction</a></h2>
|
||||
|
||||
<p>Mini-XML is a small XML parsing library that you can use to read XML data files or strings in your application without requiring large non-standard libraries. Mini-XML provides the following functionality:</p>
|
||||
|
||||
@ -15,28 +15,28 @@
|
||||
<p>Mini-XML doesn't do validation or other types of processing on the data based upon schema files or other sources of definition information.</p>
|
||||
|
||||
|
||||
<h2 class='title'><a name='USING'>Using Mini-XML</a></h2>
|
||||
<h2 class="title"><a id="USING">Using Mini-XML</a></h2>
|
||||
|
||||
<p>Mini-XML provides a single header file which you include:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
#include <mxml.h>
|
||||
</pre>
|
||||
|
||||
<p>Nodes are defined by the "<a href='#mxml_node_s'>mxml_node_t</a>" structure;
|
||||
<p>Nodes are defined by the "<a href="#mxml_node_s">mxml_node_t</a>" structure;
|
||||
the "type" member defines the node type (element, integer, opaque, real, or
|
||||
text) which determines which value you want to look at in the "value" union.
|
||||
New nodes can be created using the
|
||||
"<a href='#mxmlNewElement'>mxmlNewElement()</a>",
|
||||
"<a href='#mxmlNewInteger'>mxmlNewInteger()</a>",
|
||||
"<a href='#mxmlNewOpaque'>mxmlNewOpaque()</a>",
|
||||
"<a href='#mxmlNewReal'>mxmlNewReal()</a>", and
|
||||
"<a href='#mxmlNewText'>mxmlNewText()</a>" functions. Only elements can have
|
||||
"<a href="#mxmlNewElement">mxmlNewElement()</a>",
|
||||
"<a href="#mxmlNewInteger">mxmlNewInteger()</a>",
|
||||
"<a href="#mxmlNewOpaque">mxmlNewOpaque()</a>",
|
||||
"<a href="#mxmlNewReal">mxmlNewReal()</a>", and
|
||||
"<a href="#mxmlNewText">mxmlNewText()</a>" functions. Only elements can have
|
||||
child nodes, and the top node must be an element, usually "?xml".</p>
|
||||
|
||||
<p>You load an XML file using the "mxmlLoadFile()" function:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
FILE *fp;
|
||||
mxml_node_t *tree;
|
||||
|
||||
@ -46,9 +46,9 @@ fclose(fp);
|
||||
</pre>
|
||||
|
||||
<p>Similarly, you save an XML file using the
|
||||
"<a href='#mxmlSaveFile'>mxmlSaveFile()</a>" function:
|
||||
"<a href="#mxmlSaveFile">mxmlSaveFile()</a>" function:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
FILE *fp;
|
||||
mxml_node_t *tree;
|
||||
|
||||
@ -57,12 +57,12 @@ mxmlSaveFile(tree, fp, MXML_NO_CALLBACK);
|
||||
fclose(fp);
|
||||
</pre>
|
||||
|
||||
<p>The "<a href='#mxmlLoadString'>mxmlLoadString()</a>",
|
||||
"<a href='#mxmlSaveAllocString'>mxmlSaveAllocString()</a>", and
|
||||
"<a href='#mxmlSaveString'>mxmlSaveString()</a>" functions load XML node trees
|
||||
<p>The "<a href="#mxmlLoadString">mxmlLoadString()</a>",
|
||||
"<a href="#mxmlSaveAllocString">mxmlSaveAllocString()</a>", and
|
||||
"<a href="#mxmlSaveString">mxmlSaveString()</a>" functions load XML node trees
|
||||
from and save XML node trees to strings:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
char buffer[8192];
|
||||
char *ptr;
|
||||
mxml_node_t *tree;
|
||||
@ -79,9 +79,9 @@ ptr = mxmlSaveAllocString(tree, MXML_NO_CALLBACK);
|
||||
</pre>
|
||||
|
||||
<p>You can find a named element/node using the
|
||||
"<a href='#mxmlFindElement'>mxmlFindElement()</a>" function:</p>
|
||||
"<a href="#mxmlFindElement">mxmlFindElement()</a>" function:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
mxml_node_t *node = mxmlFindElement(tree, tree, "name",
|
||||
"attr", "value",
|
||||
MXML_DESCEND);
|
||||
@ -90,7 +90,7 @@ mxml_node_t *node = mxmlFindElement(tree, tree, "name",
|
||||
<p>The "name", "attr", and "value" arguments can be passed as
|
||||
<code>NULL</code> to act as wildcards, e.g.:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
/* Find the first "a" element */
|
||||
node = mxmlFindElement(tree, tree, "a", NULL, NULL,
|
||||
MXML_DESCEND);
|
||||
@ -115,7 +115,7 @@ node = mxmlFindElement(tree, tree, NULL, "src",
|
||||
|
||||
<p>You can also iterate with the same function:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
mxml_node_t *node;
|
||||
|
||||
for (node = mxmlFindElement(tree, tree, "name", NULL,
|
||||
@ -131,14 +131,14 @@ for (node = mxmlFindElement(tree, tree, "name", NULL,
|
||||
<p>The "mxmlFindPath()" function finds the (first) value node under a specific
|
||||
element using a "path":</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
mxml_node_t *value = mxmlFindPath(tree, "path/to/*/foo/bar");
|
||||
</pre>
|
||||
|
||||
<p>The "mxmlGetInteger()", "mxmlGetOpaque()", "mxmlGetReal()", and
|
||||
"mxmlGetText()" functions retrieve the value from a node:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
mxml_node_t *node;
|
||||
|
||||
int intvalue = mxmlGetInteger(node);
|
||||
@ -152,9 +152,9 @@ const char *textvalue = mxmlGetText(node, &whitespacevalue);
|
||||
</pre>
|
||||
|
||||
<p>Finally, once you are done with the XML data, use the
|
||||
"<a href='#mxmlDelete'>mxmlDelete()</a>" function to recursively free the
|
||||
"<a href="#mxmlDelete">mxmlDelete()</a>" function to recursively free the
|
||||
memory that is used for a particular node or the entire tree:</p>
|
||||
|
||||
<pre class='example'>
|
||||
<pre class="example">
|
||||
mxmlDelete(tree);
|
||||
</pre>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
.TH mxml 3 "Mini-XML API" "03/29/17" "Mini-XML API"
|
||||
.TH mxml 3 "Mini-XML API" "03/31/17" "Mini-XML API"
|
||||
.SH NAME
|
||||
mxml \- Mini-XML API
|
||||
.SH INCLUDE FILE
|
||||
|
||||
@ -1 +1 @@
|
||||
<h1 align='right'><a name='REFERENCE'>Appendix B - Library Reference</h1>
|
||||
<h1 align='right'><a name='REFERENCE'>Appendix B - Library Reference</a></h1>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<title>Documentation </title>
|
||||
@ -138,7 +138,7 @@ h3.title {
|
||||
</head>
|
||||
<body>
|
||||
<div class='body'>
|
||||
<h1 align='right'><a name='REFERENCE'>Appendix B - Library Reference</h1>
|
||||
<h1 align='right'><a name='REFERENCE'>Appendix B - Library Reference</a></h1>
|
||||
<h2 class="title">Contents</h2>
|
||||
<ul class="contents">
|
||||
<li><a href="#FUNCTIONS">Functions</a><ul class="code">
|
||||
@ -236,8 +236,8 @@ using a SAX callback.">mxmlSAXLoadString</a></li>
|
||||
<li><a href="#mxml_type_e" title="The XML node type.">mxml_type_e</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
<h2 class="title"><a name="FUNCTIONS">Functions</a></h2>
|
||||
<h3 class="function"><a name="mxmlAdd">mxmlAdd</a></h3>
|
||||
<h2 class="title"><a id="FUNCTIONS">Functions</a></h2>
|
||||
<h3 class="function"><a id="mxmlAdd">mxmlAdd</a></h3>
|
||||
<p class="description">Add a node to a tree.</p>
|
||||
<p class="code">
|
||||
void mxmlAdd (<br>
|
||||
@ -264,7 +264,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlDelete">mxmlDelete</a></h3>
|
||||
<p class="description">Delete a node and all of its children.</p>
|
||||
<p class="code">
|
||||
void mxmlDelete (<br>
|
||||
@ -278,7 +278,7 @@ void mxmlDelete (<br>
|
||||
<h4 class="discussion">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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.4 </span><a id="mxmlElementDeleteAttr">mxmlElementDeleteAttr</a></h3>
|
||||
<p class="description">Delete an attribute.</p>
|
||||
<p class="code">
|
||||
void mxmlElementDeleteAttr (<br>
|
||||
@ -292,7 +292,7 @@ void mxmlElementDeleteAttr (<br>
|
||||
<dt>name</dt>
|
||||
<dd class="description">Attribute name</dd>
|
||||
</dl>
|
||||
<h3 class="function"><a name="mxmlElementGetAttr">mxmlElementGetAttr</a></h3>
|
||||
<h3 class="function"><a id="mxmlElementGetAttr">mxmlElementGetAttr</a></h3>
|
||||
<p class="description">Get an attribute.</p>
|
||||
<p class="code">
|
||||
const char *mxmlElementGetAttr (<br>
|
||||
@ -311,7 +311,7 @@ const char *mxmlElementGetAttr (<br>
|
||||
<h4 class="discussion">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>
|
||||
<h3 class="function"><a id="mxmlElementSetAttr">mxmlElementSetAttr</a></h3>
|
||||
<p class="description">Set an attribute.</p>
|
||||
<p class="code">
|
||||
void mxmlElementSetAttr (<br>
|
||||
@ -333,7 +333,7 @@ void mxmlElementSetAttr (<br>
|
||||
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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlElementSetAttrf">mxmlElementSetAttrf</a></h3>
|
||||
<p class="description">Set an attribute with a formatted value.</p>
|
||||
<p class="code">
|
||||
void mxmlElementSetAttrf (<br>
|
||||
@ -360,7 +360,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlEntityAddCallback">mxmlEntityAddCallback</a></h3>
|
||||
<p class="description">Add a callback to convert entities to Unicode.</p>
|
||||
<p class="code">
|
||||
int mxmlEntityAddCallback (<br>
|
||||
@ -373,7 +373,7 @@ int mxmlEntityAddCallback (<br>
|
||||
</dl>
|
||||
<h4 class="returnvalue">Return Value</h4>
|
||||
<p class="description">0 on success, -1 on failure</p>
|
||||
<h3 class="function"><a name="mxmlEntityGetName">mxmlEntityGetName</a></h3>
|
||||
<h3 class="function"><a id="mxmlEntityGetName">mxmlEntityGetName</a></h3>
|
||||
<p class="description">Get the name that corresponds to the character value.</p>
|
||||
<p class="code">
|
||||
const char *mxmlEntityGetName (<br>
|
||||
@ -388,7 +388,7 @@ const char *mxmlEntityGetName (<br>
|
||||
<p class="description">Entity name or NULL</p>
|
||||
<h4 class="discussion">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>
|
||||
<h3 class="function"><a id="mxmlEntityGetValue">mxmlEntityGetValue</a></h3>
|
||||
<p class="description">Get the character corresponding to a named entity.</p>
|
||||
<p class="code">
|
||||
int mxmlEntityGetValue (<br>
|
||||
@ -404,7 +404,7 @@ int mxmlEntityGetValue (<br>
|
||||
<h4 class="discussion">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>
|
||||
<h3 class="function"><a id="mxmlEntityRemoveCallback">mxmlEntityRemoveCallback</a></h3>
|
||||
<p class="description">Remove a callback.</p>
|
||||
<p class="code">
|
||||
void mxmlEntityRemoveCallback (<br>
|
||||
@ -415,7 +415,7 @@ void mxmlEntityRemoveCallback (<br>
|
||||
<dt>cb</dt>
|
||||
<dd class="description">Callback function to remove</dd>
|
||||
</dl>
|
||||
<h3 class="function"><a name="mxmlFindElement">mxmlFindElement</a></h3>
|
||||
<h3 class="function"><a id="mxmlFindElement">mxmlFindElement</a></h3>
|
||||
<p class="description">Find the named element.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlFindElement (<br>
|
||||
@ -452,7 +452,7 @@ 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"><span class="info"> Mini-XML 2.7 </span><a name="mxmlFindPath">mxmlFindPath</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlFindPath">mxmlFindPath</a></h3>
|
||||
<p class="description">Find a node with the given path.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlFindPath (<br>
|
||||
@ -477,7 +477,7 @@ The first child node of the found node is returned if the given node has
|
||||
children and the first child is a value node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetCDATA">mxmlGetCDATA</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetCDATA">mxmlGetCDATA</a></h3>
|
||||
<p class="description">Get the value for a CDATA node.</p>
|
||||
<p class="code">
|
||||
const char *mxmlGetCDATA (<br>
|
||||
@ -494,7 +494,7 @@ const char *mxmlGetCDATA (<br>
|
||||
<p class="discussion"><code>NULL</code> is returned if the node is not a CDATA element.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetCustom">mxmlGetCustom</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetCustom">mxmlGetCustom</a></h3>
|
||||
<p class="description">Get the value for a custom node.</p>
|
||||
<p class="code">
|
||||
const void *mxmlGetCustom (<br>
|
||||
@ -512,7 +512,7 @@ const void *mxmlGetCustom (<br>
|
||||
value node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetElement">mxmlGetElement</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetElement">mxmlGetElement</a></h3>
|
||||
<p class="description">Get the name for an element node.</p>
|
||||
<p class="code">
|
||||
const char *mxmlGetElement (<br>
|
||||
@ -529,7 +529,7 @@ const char *mxmlGetElement (<br>
|
||||
<p class="discussion"><code>NULL</code> is returned if the node is not an element node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetFirstChild">mxmlGetFirstChild</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetFirstChild">mxmlGetFirstChild</a></h3>
|
||||
<p class="description">Get the first child of an element node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlGetFirstChild (<br>
|
||||
@ -547,7 +547,7 @@ const char *mxmlGetElement (<br>
|
||||
has no children.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetInteger">mxmlGetInteger</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetInteger">mxmlGetInteger</a></h3>
|
||||
<p class="description">Get the integer value from the specified node or its
|
||||
first child.</p>
|
||||
<p class="code">
|
||||
@ -565,7 +565,7 @@ int mxmlGetInteger (<br>
|
||||
<p class="discussion">0 is returned if the node (or its first child) is not an integer value node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetLastChild">mxmlGetLastChild</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetLastChild">mxmlGetLastChild</a></h3>
|
||||
<p class="description">Get the last child of an element node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlGetLastChild (<br>
|
||||
@ -583,7 +583,7 @@ int mxmlGetInteger (<br>
|
||||
has no children.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><a name="mxmlGetNextSibling">mxmlGetNextSibling</a></h3>
|
||||
<h3 class="function"><a id="mxmlGetNextSibling">mxmlGetNextSibling</a></h3>
|
||||
<p class="description">Return the node type...</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlGetNextSibling (<br>
|
||||
@ -599,7 +599,7 @@ has no children.
|
||||
<p class="discussion"><code>NULL</code> is returned if this is the last child for the current parent.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetOpaque">mxmlGetOpaque</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetOpaque">mxmlGetOpaque</a></h3>
|
||||
<p class="description">Get an opaque string value for a node or its first child.</p>
|
||||
<p class="code">
|
||||
const char *mxmlGetOpaque (<br>
|
||||
@ -617,7 +617,7 @@ const char *mxmlGetOpaque (<br>
|
||||
value node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetParent">mxmlGetParent</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetParent">mxmlGetParent</a></h3>
|
||||
<p class="description">Get the parent node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlGetParent (<br>
|
||||
@ -634,7 +634,7 @@ value node.
|
||||
<p class="discussion"><code>NULL</code> is returned for a root node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetPrevSibling">mxmlGetPrevSibling</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetPrevSibling">mxmlGetPrevSibling</a></h3>
|
||||
<p class="description">Get the previous node for the current parent.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlGetPrevSibling (<br>
|
||||
@ -651,7 +651,7 @@ value node.
|
||||
<p class="discussion"><code>NULL</code> is returned if this is the first child for the current parent.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetReal">mxmlGetReal</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetReal">mxmlGetReal</a></h3>
|
||||
<p class="description">Get the real value for a node or its first child.</p>
|
||||
<p class="code">
|
||||
double mxmlGetReal (<br>
|
||||
@ -668,7 +668,7 @@ double mxmlGetReal (<br>
|
||||
<p class="discussion">0.0 is returned if the node (or its first child) is not a real value node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetRefCount">mxmlGetRefCount</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetRefCount">mxmlGetRefCount</a></h3>
|
||||
<p class="description">Get the current reference (use) count for a node.</p>
|
||||
<p class="code">
|
||||
int mxmlGetRefCount (<br>
|
||||
@ -687,7 +687,7 @@ and <a href="#mxmlRelease"><code>mxmlRelease</code></a> functions to increment a
|
||||
reference count.
|
||||
|
||||
.</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetText">mxmlGetText</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetText">mxmlGetText</a></h3>
|
||||
<p class="description">Get the text value for a node or its first child.</p>
|
||||
<p class="code">
|
||||
const char *mxmlGetText (<br>
|
||||
@ -708,7 +708,7 @@ const char *mxmlGetText (<br>
|
||||
The "whitespace" argument can be NULL.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetType">mxmlGetType</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetType">mxmlGetType</a></h3>
|
||||
<p class="description">Get the node type.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_type_t">mxml_type_t</a> mxmlGetType (<br>
|
||||
@ -725,7 +725,7 @@ The "whitespace" argument can be NULL.
|
||||
<p class="discussion"><code>MXML_IGNORE</code> is returned if "node" is <code>NULL</code>.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlGetUserData">mxmlGetUserData</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlGetUserData">mxmlGetUserData</a></h3>
|
||||
<p class="description">Get the user data pointer for a node.</p>
|
||||
<p class="code">
|
||||
void *mxmlGetUserData (<br>
|
||||
@ -738,7 +738,7 @@ void *mxmlGetUserData (<br>
|
||||
</dl>
|
||||
<h4 class="returnvalue">Return Value</h4>
|
||||
<p class="description">User data pointer</p>
|
||||
<h3 class="function"><a name="mxmlIndexDelete">mxmlIndexDelete</a></h3>
|
||||
<h3 class="function"><a id="mxmlIndexDelete">mxmlIndexDelete</a></h3>
|
||||
<p class="description">Delete an index.</p>
|
||||
<p class="code">
|
||||
void mxmlIndexDelete (<br>
|
||||
@ -749,7 +749,7 @@ void mxmlIndexDelete (<br>
|
||||
<dt>ind</dt>
|
||||
<dd class="description">Index to delete</dd>
|
||||
</dl>
|
||||
<h3 class="function"><a name="mxmlIndexEnum">mxmlIndexEnum</a></h3>
|
||||
<h3 class="function"><a id="mxmlIndexEnum">mxmlIndexEnum</a></h3>
|
||||
<p class="description">Return the next node in the index.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlIndexEnum (<br>
|
||||
@ -764,7 +764,7 @@ void mxmlIndexDelete (<br>
|
||||
<p class="description">Next node or NULL if there is none</p>
|
||||
<h4 class="discussion">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>
|
||||
<h3 class="function"><a id="mxmlIndexFind">mxmlIndexFind</a></h3>
|
||||
<p class="description">Find the next matching node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlIndexFind (<br>
|
||||
@ -788,7 +788,7 @@ void mxmlIndexDelete (<br>
|
||||
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"><span class="info"> Mini-XML 2.7 </span><a name="mxmlIndexGetCount">mxmlIndexGetCount</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlIndexGetCount">mxmlIndexGetCount</a></h3>
|
||||
<p class="description">Get the number of nodes in an index.</p>
|
||||
<p class="code">
|
||||
int mxmlIndexGetCount (<br>
|
||||
@ -801,7 +801,7 @@ int mxmlIndexGetCount (<br>
|
||||
</dl>
|
||||
<h4 class="returnvalue">Return Value</h4>
|
||||
<p class="description">Number of nodes in index</p>
|
||||
<h3 class="function"><a name="mxmlIndexNew">mxmlIndexNew</a></h3>
|
||||
<h3 class="function"><a id="mxmlIndexNew">mxmlIndexNew</a></h3>
|
||||
<p class="description">Create a new index.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_index_t">mxml_index_t</a> *mxmlIndexNew (<br>
|
||||
@ -826,7 +826,7 @@ attribute. If both "element" and "attr" are NULL, then the i
|
||||
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>
|
||||
<h3 class="function"><a id="mxmlIndexReset">mxmlIndexReset</a></h3>
|
||||
<p class="description">Reset the enumeration/find pointer in the index and
|
||||
return the first node in the index.</p>
|
||||
<p class="code">
|
||||
@ -843,7 +843,7 @@ return the first node in the index.</p>
|
||||
<h4 class="discussion">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>
|
||||
<h3 class="function"><a id="mxmlLoadFd">mxmlLoadFd</a></h3>
|
||||
<p class="description">Load a file descriptor into an XML node tree.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlLoadFd (<br>
|
||||
@ -873,7 +873,7 @@ MXML_ELEMENT or MXML_TEXT nodes.<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>
|
||||
<h3 class="function"><a id="mxmlLoadFile">mxmlLoadFile</a></h3>
|
||||
<p class="description">Load a file into an XML node tree.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlLoadFile (<br>
|
||||
@ -903,7 +903,7 @@ MXML_ELEMENT or MXML_TEXT nodes.<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>
|
||||
<h3 class="function"><a id="mxmlLoadString">mxmlLoadString</a></h3>
|
||||
<p class="description">Load a string into an XML node tree.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlLoadString (<br>
|
||||
@ -933,7 +933,7 @@ MXML_ELEMENT or MXML_TEXT nodes.<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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlNewCDATA">mxmlNewCDATA</a></h3>
|
||||
<p class="description">Create a new CDATA node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewCDATA (<br>
|
||||
@ -956,7 +956,7 @@ 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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.1 </span><a id="mxmlNewCustom">mxmlNewCustom</a></h3>
|
||||
<p class="description">Create a new custom data node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewCustom (<br>
|
||||
@ -982,7 +982,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlNewElement">mxmlNewElement</a></h3>
|
||||
<p class="description">Create a new element node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewElement (<br>
|
||||
@ -1002,7 +1002,7 @@ node is not dynamically allocated or is separately managed.
|
||||
<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>
|
||||
<h3 class="function"><a id="mxmlNewInteger">mxmlNewInteger</a></h3>
|
||||
<p class="description">Create a new integer node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewInteger (<br>
|
||||
@ -1022,7 +1022,7 @@ element node has no parent.</p>
|
||||
<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>
|
||||
<h3 class="function"><a id="mxmlNewOpaque">mxmlNewOpaque</a></h3>
|
||||
<p class="description">Create a new opaque string.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewOpaque (<br>
|
||||
@ -1043,7 +1043,7 @@ integer node has no parent.</p>
|
||||
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>
|
||||
<h3 class="function"><a id="mxmlNewReal">mxmlNewReal</a></h3>
|
||||
<p class="description">Create a new real number node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewReal (<br>
|
||||
@ -1063,7 +1063,7 @@ is copied into the new node.</p>
|
||||
<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>
|
||||
<h3 class="function"><a id="mxmlNewText">mxmlNewText</a></h3>
|
||||
<p class="description">Create a new text fragment node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewText (<br>
|
||||
@ -1088,7 +1088,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlNewTextf">mxmlNewTextf</a></h3>
|
||||
<p class="description">Create a new formatted text fragment node.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewTextf (<br>
|
||||
@ -1116,7 +1116,7 @@ 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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlNewXML">mxmlNewXML</a></h3>
|
||||
<p class="description">Create a new XML document tree.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlNewXML (<br>
|
||||
@ -1134,7 +1134,7 @@ string must be nul-terminated and is formatted into the new node.</p>
|
||||
?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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlRelease">mxmlRelease</a></h3>
|
||||
<p class="description">Release a node.</p>
|
||||
<p class="code">
|
||||
int mxmlRelease (<br>
|
||||
@ -1152,7 +1152,7 @@ int mxmlRelease (<br>
|
||||
is deleted via mxmlDelete().
|
||||
|
||||
</p>
|
||||
<h3 class="function"><a name="mxmlRemove">mxmlRemove</a></h3>
|
||||
<h3 class="function"><a id="mxmlRemove">mxmlRemove</a></h3>
|
||||
<p class="description">Remove a node from its parent.</p>
|
||||
<p class="code">
|
||||
void mxmlRemove (<br>
|
||||
@ -1166,7 +1166,7 @@ void mxmlRemove (<br>
|
||||
<h4 class="discussion">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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlRetain">mxmlRetain</a></h3>
|
||||
<p class="description">Retain a node.</p>
|
||||
<p class="code">
|
||||
int mxmlRetain (<br>
|
||||
@ -1179,7 +1179,7 @@ int mxmlRetain (<br>
|
||||
</dl>
|
||||
<h4 class="returnvalue">Return Value</h4>
|
||||
<p class="description">New reference count</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a name="mxmlSAXLoadFd">mxmlSAXLoadFd</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlSAXLoadFd">mxmlSAXLoadFd</a></h3>
|
||||
<p class="description">Load a file descriptor into an XML node tree
|
||||
using a SAX callback.</p>
|
||||
<p class="code">
|
||||
@ -1222,7 +1222,7 @@ 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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlSAXLoadFile">mxmlSAXLoadFile</a></h3>
|
||||
<p class="description">Load a file into an XML node tree
|
||||
using a SAX callback.</p>
|
||||
<p class="code">
|
||||
@ -1265,7 +1265,7 @@ 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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlSAXLoadString">mxmlSAXLoadString</a></h3>
|
||||
<p class="description">Load a string into an XML node tree
|
||||
using a SAX callback.</p>
|
||||
<p class="code">
|
||||
@ -1308,7 +1308,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlSaveAllocString">mxmlSaveAllocString</a></h3>
|
||||
<p class="description">Save an XML tree to an allocated string.</p>
|
||||
<p class="code">
|
||||
char *mxmlSaveAllocString (<br>
|
||||
@ -1336,7 +1336,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlSaveFd">mxmlSaveFd</a></h3>
|
||||
<p class="description">Save an XML tree to a file descriptor.</p>
|
||||
<p class="code">
|
||||
int mxmlSaveFd (<br>
|
||||
@ -1361,7 +1361,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlSaveFile">mxmlSaveFile</a></h3>
|
||||
<p class="description">Save an XML tree to a file.</p>
|
||||
<p class="code">
|
||||
int mxmlSaveFile (<br>
|
||||
@ -1386,7 +1386,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlSaveString">mxmlSaveString</a></h3>
|
||||
<p class="description">Save an XML node tree to a string.</p>
|
||||
<p class="code">
|
||||
int mxmlSaveString (<br>
|
||||
@ -1418,7 +1418,7 @@ 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>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlSetCDATA">mxmlSetCDATA</a></h3>
|
||||
<p class="description">Set the element name of a CDATA node.</p>
|
||||
<p class="code">
|
||||
int mxmlSetCDATA (<br>
|
||||
@ -1438,7 +1438,7 @@ int mxmlSetCDATA (<br>
|
||||
<p class="discussion">The node is not changed if it (or its first child) is not a CDATA element node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.1 </span><a name="mxmlSetCustom">mxmlSetCustom</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.1 </span><a id="mxmlSetCustom">mxmlSetCustom</a></h3>
|
||||
<p class="description">Set the data and destructor of a custom data node.</p>
|
||||
<p class="code">
|
||||
int mxmlSetCustom (<br>
|
||||
@ -1461,7 +1461,7 @@ int mxmlSetCustom (<br>
|
||||
<p class="discussion">The node is not changed if it (or its first child) is not a custom node.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><a name="mxmlSetCustomHandlers">mxmlSetCustomHandlers</a></h3>
|
||||
<h3 class="function"><a id="mxmlSetCustomHandlers">mxmlSetCustomHandlers</a></h3>
|
||||
<p class="description">Set the handling functions for custom data.</p>
|
||||
<p class="code">
|
||||
void mxmlSetCustomHandlers (<br>
|
||||
@ -1481,7 +1481,7 @@ 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>
|
||||
<h3 class="function"><a id="mxmlSetElement">mxmlSetElement</a></h3>
|
||||
<p class="description">Set the name of an element node.</p>
|
||||
<p class="code">
|
||||
int mxmlSetElement (<br>
|
||||
@ -1499,7 +1499,7 @@ int mxmlSetElement (<br>
|
||||
<p class="description">0 on success, -1 on failure</p>
|
||||
<h4 class="discussion">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>
|
||||
<h3 class="function"><a id="mxmlSetErrorCallback">mxmlSetErrorCallback</a></h3>
|
||||
<p class="description">Set the error message callback.</p>
|
||||
<p class="code">
|
||||
void mxmlSetErrorCallback (<br>
|
||||
@ -1510,7 +1510,7 @@ void mxmlSetErrorCallback (<br>
|
||||
<dt>cb</dt>
|
||||
<dd class="description">Error callback function</dd>
|
||||
</dl>
|
||||
<h3 class="function"><a name="mxmlSetInteger">mxmlSetInteger</a></h3>
|
||||
<h3 class="function"><a id="mxmlSetInteger">mxmlSetInteger</a></h3>
|
||||
<p class="description">Set the value of an integer node.</p>
|
||||
<p class="code">
|
||||
int mxmlSetInteger (<br>
|
||||
@ -1528,7 +1528,7 @@ int mxmlSetInteger (<br>
|
||||
<p class="description">0 on success, -1 on failure</p>
|
||||
<h4 class="discussion">Discussion</h4>
|
||||
<p class="discussion">The node is not changed if it (or its first child) is not an integer node.</p>
|
||||
<h3 class="function"><a name="mxmlSetOpaque">mxmlSetOpaque</a></h3>
|
||||
<h3 class="function"><a id="mxmlSetOpaque">mxmlSetOpaque</a></h3>
|
||||
<p class="description">Set the value of an opaque node.</p>
|
||||
<p class="code">
|
||||
int mxmlSetOpaque (<br>
|
||||
@ -1546,7 +1546,7 @@ int mxmlSetOpaque (<br>
|
||||
<p class="description">0 on success, -1 on failure</p>
|
||||
<h4 class="discussion">Discussion</h4>
|
||||
<p class="discussion">The node is not changed if it (or its first child) is not an opaque node.</p>
|
||||
<h3 class="function"><a name="mxmlSetReal">mxmlSetReal</a></h3>
|
||||
<h3 class="function"><a id="mxmlSetReal">mxmlSetReal</a></h3>
|
||||
<p class="description">Set the value of a real number node.</p>
|
||||
<p class="code">
|
||||
int mxmlSetReal (<br>
|
||||
@ -1564,7 +1564,7 @@ int mxmlSetReal (<br>
|
||||
<p class="description">0 on success, -1 on failure</p>
|
||||
<h4 class="discussion">Discussion</h4>
|
||||
<p class="discussion">The node is not changed if it (or its first child) is not a real number node.</p>
|
||||
<h3 class="function"><a name="mxmlSetText">mxmlSetText</a></h3>
|
||||
<h3 class="function"><a id="mxmlSetText">mxmlSetText</a></h3>
|
||||
<p class="description">Set the value of a text node.</p>
|
||||
<p class="code">
|
||||
int mxmlSetText (<br>
|
||||
@ -1585,7 +1585,7 @@ int mxmlSetText (<br>
|
||||
<p class="description">0 on success, -1 on failure</p>
|
||||
<h4 class="discussion">Discussion</h4>
|
||||
<p class="discussion">The node is not changed if it (or its first child) is not a text node.</p>
|
||||
<h3 class="function"><a name="mxmlSetTextf">mxmlSetTextf</a></h3>
|
||||
<h3 class="function"><a id="mxmlSetTextf">mxmlSetTextf</a></h3>
|
||||
<p class="description">Set the value of a text node to a formatted string.</p>
|
||||
<p class="code">
|
||||
int mxmlSetTextf (<br>
|
||||
@ -1609,7 +1609,7 @@ int mxmlSetTextf (<br>
|
||||
<p class="description">0 on success, -1 on failure</p>
|
||||
<h4 class="discussion">Discussion</h4>
|
||||
<p class="discussion">The node is not changed if it (or its first child) is not a text node.</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a name="mxmlSetUserData">mxmlSetUserData</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.7 </span><a id="mxmlSetUserData">mxmlSetUserData</a></h3>
|
||||
<p class="description">Set the user data pointer for a node.</p>
|
||||
<p class="code">
|
||||
int mxmlSetUserData (<br>
|
||||
@ -1625,7 +1625,7 @@ int mxmlSetUserData (<br>
|
||||
</dl>
|
||||
<h4 class="returnvalue">Return Value</h4>
|
||||
<p class="description">0 on success, -1 on failure</p>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a name="mxmlSetWrapMargin">mxmlSetWrapMargin</a></h3>
|
||||
<h3 class="function"><span class="info"> Mini-XML 2.3 </span><a id="mxmlSetWrapMargin">mxmlSetWrapMargin</a></h3>
|
||||
<p class="description">Set the wrap margin when saving XML data.</p>
|
||||
<p class="code">
|
||||
void mxmlSetWrapMargin (<br>
|
||||
@ -1640,7 +1640,7 @@ void mxmlSetWrapMargin (<br>
|
||||
<p class="discussion">Wrapping is disabled when "column" is 0.
|
||||
|
||||
</p>
|
||||
<h3 class="function"><a name="mxmlWalkNext">mxmlWalkNext</a></h3>
|
||||
<h3 class="function"><a id="mxmlWalkNext">mxmlWalkNext</a></h3>
|
||||
<p class="description">Walk to the next logical node in the tree.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlWalkNext (<br>
|
||||
@ -1663,7 +1663,7 @@ void mxmlSetWrapMargin (<br>
|
||||
<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>
|
||||
<h3 class="function"><a id="mxmlWalkPrev">mxmlWalkPrev</a></h3>
|
||||
<p class="description">Walk to the previous logical node in the tree.</p>
|
||||
<p class="code">
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *mxmlWalkPrev (<br>
|
||||
@ -1686,69 +1686,69 @@ the node's children.</p>
|
||||
<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>
|
||||
<h2 class="title"><a name="TYPES">Data Types</a></h2>
|
||||
<h3 class="typedef"><a name="mxml_custom_destroy_cb_t">mxml_custom_destroy_cb_t</a></h3>
|
||||
<h2 class="title"><a id="TYPES">Data Types</a></h2>
|
||||
<h3 class="typedef"><a id="mxml_custom_destroy_cb_t">mxml_custom_destroy_cb_t</a></h3>
|
||||
<p class="description">Custom data destructor</p>
|
||||
<p class="code">
|
||||
typedef void (*mxml_custom_destroy_cb_t)(void *);
|
||||
</p>
|
||||
<h3 class="typedef"><a name="mxml_custom_load_cb_t">mxml_custom_load_cb_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_custom_load_cb_t">mxml_custom_load_cb_t</a></h3>
|
||||
<p class="description">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>
|
||||
<h3 class="typedef"><a name="mxml_custom_save_cb_t">mxml_custom_save_cb_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_custom_save_cb_t">mxml_custom_save_cb_t</a></h3>
|
||||
<p class="description">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>
|
||||
<h3 class="typedef"><a name="mxml_entity_cb_t">mxml_entity_cb_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_entity_cb_t">mxml_entity_cb_t</a></h3>
|
||||
<p class="description">Entity callback function</p>
|
||||
<p class="code">
|
||||
typedef int (*mxml_entity_cb_t)(const char *);
|
||||
</p>
|
||||
<h3 class="typedef"><a name="mxml_error_cb_t">mxml_error_cb_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_error_cb_t">mxml_error_cb_t</a></h3>
|
||||
<p class="description">Error callback function</p>
|
||||
<p class="code">
|
||||
typedef void (*mxml_error_cb_t)(const char *);
|
||||
</p>
|
||||
<h3 class="typedef"><a name="mxml_index_t">mxml_index_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_index_t">mxml_index_t</a></h3>
|
||||
<p class="description">An XML node index.</p>
|
||||
<p class="code">
|
||||
typedef struct <a href="#mxml_index_s">mxml_index_s</a> mxml_index_t;
|
||||
</p>
|
||||
<h3 class="typedef"><a name="mxml_load_cb_t">mxml_load_cb_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_load_cb_t">mxml_load_cb_t</a></h3>
|
||||
<p class="description">Load callback function</p>
|
||||
<p class="code">
|
||||
typedef <a href="#mxml_type_t">mxml_type_t</a> (*mxml_load_cb_t)(<a href="#mxml_node_t">mxml_node_t</a> *);
|
||||
</p>
|
||||
<h3 class="typedef"><a name="mxml_node_t">mxml_node_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_node_t">mxml_node_t</a></h3>
|
||||
<p class="description">An XML node.</p>
|
||||
<p class="code">
|
||||
typedef struct <a href="#mxml_node_s">mxml_node_s</a> mxml_node_t;
|
||||
</p>
|
||||
<h3 class="typedef"><a name="mxml_save_cb_t">mxml_save_cb_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_save_cb_t">mxml_save_cb_t</a></h3>
|
||||
<p class="description">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>
|
||||
<h3 class="typedef"><a name="mxml_sax_cb_t">mxml_sax_cb_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_sax_cb_t">mxml_sax_cb_t</a></h3>
|
||||
<p class="description">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>
|
||||
<h3 class="typedef"><a name="mxml_sax_event_t">mxml_sax_event_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_sax_event_t">mxml_sax_event_t</a></h3>
|
||||
<p class="description">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>
|
||||
<h3 class="typedef"><a name="mxml_type_t">mxml_type_t</a></h3>
|
||||
<h3 class="typedef"><a id="mxml_type_t">mxml_type_t</a></h3>
|
||||
<p class="description">The XML node type.</p>
|
||||
<p class="code">
|
||||
typedef enum <a href="#mxml_type_e">mxml_type_e</a> mxml_type_t;
|
||||
</p>
|
||||
<h2 class="title"><a name="ENUMERATIONS">Constants</a></h2>
|
||||
<h3 class="enumeration"><a name="mxml_sax_event_e">mxml_sax_event_e</a></h3>
|
||||
<h2 class="title"><a id="ENUMERATIONS">Constants</a></h2>
|
||||
<h3 class="enumeration"><a id="mxml_sax_event_e">mxml_sax_event_e</a></h3>
|
||||
<p class="description">SAX event type.</p>
|
||||
<h4 class="constants">Constants</h4>
|
||||
<dl>
|
||||
@ -1765,7 +1765,7 @@ typedef enum <a href="#mxml_type_e">mxml_type_e</a> mxml_type_t;
|
||||
<dt>MXML_SAX_ELEMENT_OPEN </dt>
|
||||
<dd class="description">Element opened</dd>
|
||||
</dl>
|
||||
<h3 class="enumeration"><a name="mxml_type_e">mxml_type_e</a></h3>
|
||||
<h3 class="enumeration"><a id="mxml_type_e">mxml_type_e</a></h3>
|
||||
<p class="description">The XML node type.</p>
|
||||
<h4 class="constants">Constants</h4>
|
||||
<dl>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user