@ -85,11 +85,20 @@ div.contents ul.contents {
}
.variable {
}
blockquote {
border: solid thin gray;
box-shadow: 3px 3px 5px rgba(0,0,0,0.5);
padding: 0px 10px;
page-break-inside: avoid;
}
p code, li code, p.code, pre, ul.code li {
background: rgba(127,127,127,0.1);
border: thin dotted gray;
font-family: monospace;
font-size: 90%;
hyphens: manual;
-webkit-hyphens: manual;
page-break-inside: avoid;
}
p.code, pre, ul.code li {
padding: 10px;
@ -196,6 +205,7 @@ h3.title {
< li > < a href = "#mxmlNewElement" > mxmlNewElement< / a > < / li >
< li > < a href = "#mxmlNewInteger" > mxmlNewInteger< / a > < / li >
< li > < a href = "#mxmlNewOpaque" > mxmlNewOpaque< / a > < / li >
< li > < a href = "#mxmlNewOpaquef" > mxmlNewOpaquef< / a > < / li >
< li > < a href = "#mxmlNewReal" > mxmlNewReal< / a > < / li >
< li > < a href = "#mxmlNewText" > mxmlNewText< / a > < / li >
< li > < a href = "#mxmlNewTextf" > mxmlNewTextf< / a > < / li >
@ -217,6 +227,7 @@ h3.title {
< li > < a href = "#mxmlSetErrorCallback" > mxmlSetErrorCallback< / a > < / li >
< li > < a href = "#mxmlSetInteger" > mxmlSetInteger< / a > < / li >
< li > < a href = "#mxmlSetOpaque" > mxmlSetOpaque< / a > < / li >
< li > < a href = "#mxmlSetOpaquef" > mxmlSetOpaquef< / a > < / li >
< li > < a href = "#mxmlSetReal" > mxmlSetReal< / a > < / li >
< li > < a href = "#mxmlSetText" > mxmlSetText< / a > < / li >
< li > < a href = "#mxmlSetTextf" > mxmlSetTextf< / a > < / li >
@ -261,19 +272,12 @@ void mxmlAdd (<br>
< dt > parent< / dt >
< dd class = "description" > Parent node< / dd >
< dt > where< / dt >
< dd class = "description" > Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER< / dd >
< dd class = "description" > Where to add, < code > < / code > < code > < / code > < / dd >
< dt > child< / dt >
< dd class = "description" > Child node for where or MXML_ADD_TO_PARENT< / dd >
< dd class = "description" > Child node for where or < code > < / code > < / dd >
< dt > node< / dt >
< dd class = "description" > Node to add< / dd >
< / dl >
< h4 class = "discussion" > 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 id = "mxmlDelete" > mxmlDelete< / a > < / h3 >
< p class = "description" > Delete a node and all of its children.< / p >
< p class = "code" >
@ -285,9 +289,6 @@ void mxmlDelete (<br>
< dt > node< / dt >
< dd class = "description" > Node to delete< / dd >
< / dl >
< 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 id = "mxmlElementDeleteAttr" > mxmlElementDeleteAttr< / a > < / h3 >
< p class = "description" > Delete an attribute.< / p >
< p class = "code" >
@ -317,10 +318,7 @@ const char *mxmlElementGetAttr (<br>
< dd class = "description" > Name of attribute< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Attribute value or NULL< / p >
< 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 >
< p class = "description" > Attribute value or < code > NULL< / code > < / p >
< h3 class = "function" > < span class = "info" >   Mini-XML 2.11  < / span > < a id = "mxmlElementGetAttrByIndex" > mxmlElementGetAttrByIndex< / a > < / h3 >
< p class = "description" > Get an element attribute by index.< / p >
< p class = "code" >
@ -340,11 +338,6 @@ const char *mxmlElementGetAttrByIndex (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Attribute value< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > The index (" idx" ) is 0-based. < code > NULL< / code > is returned if the specified index
is out of range.
< / p >
< h3 class = "function" > < span class = "info" >   Mini-XML 2.11  < / span > < a id = "mxmlElementGetAttrCount" > mxmlElementGetAttrCount< / a > < / h3 >
< p class = "description" > Get the number of element attributes.< / p >
< p class = "code" >
@ -375,11 +368,6 @@ void mxmlElementSetAttr (<br>
< dt > value< / dt >
< dd class = "description" > Attribute value< / dd >
< / dl >
< h4 class = "discussion" > 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 id = "mxmlElementSetAttrf" > mxmlElementSetAttrf< / a > < / h3 >
< p class = "description" > Set an attribute with a formatted value.< / p >
< p class = "code" >
@ -400,13 +388,6 @@ void mxmlElementSetAttrf (<br>
< dt > ...< / dt >
< dd class = "description" > Additional arguments as needed< / dd >
< / dl >
< h4 class = "discussion" > 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 id = "mxmlEntityAddCallback" > mxmlEntityAddCallback< / a > < / h3 >
< p class = "description" > Add a callback to convert entities to Unicode.< / p >
< p class = "code" >
@ -432,9 +413,7 @@ const char *mxmlEntityGetName (<br>
< dd class = "description" > Character value< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 >
< p class = "description" > Entity name or < code > NULL< / code > < / p >
< h3 class = "function" > < a id = "mxmlEntityGetValue" > mxmlEntityGetValue< / a > < / h3 >
< p class = "description" > Get the character corresponding to a named entity.< / p >
< p class = "code" >
@ -448,9 +427,6 @@ int mxmlEntityGetValue (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Character value or -1 on error< / p >
< 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 id = "mxmlEntityRemoveCallback" > mxmlEntityRemoveCallback< / a > < / h3 >
< p class = "description" > Remove a callback.< / p >
< p class = "code" >
@ -468,7 +444,7 @@ void mxmlEntityRemoveCallback (<br>
< 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 *element ,< br >
        const char *attr,< br >
        const char *value,< br >
        int descend< br >
@ -479,26 +455,17 @@ void mxmlEntityRemoveCallback (<br>
< dd class = "description" > Current node< / dd >
< dt > top< / dt >
< dd class = "description" > Top node< / dd >
< dt > name < / dt >
< dd class = "description" > Element name or NULL for any< / dd >
< dt > element < / dt >
< dd class = "description" > Element name or < code > < / code > < / dd >
< dt > attr< / dt >
< dd class = "description" > Attribute name, or NULL for none< / dd >
< dd class = "description" > Attribute name, or < code > < / code > < / dd >
< dt > value< / dt >
< dd class = "description" > Attribute value, or NULL for any< / dd >
< dd class = "description" > Attribute value, or < code > < / code > < / dd >
< dt > descend< / dt >
< dd class = "description" > Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST< / dd >
< dd class = "description" > Descend into tree - < code > < / code > < code > < / code > < code > < / code > < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Element node or NULL< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > Element node or < code > NULL< / code > < / p >
< 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" >
@ -514,16 +481,7 @@ constrains the search to a particular node's children.</p>
< dd class = "description" > Path to element< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Found node or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > The " path" is a slash-separated list of element names. The name " *" is
considered a wildcard for one or more levels of elements. For example,
" foo/one/two" , " bar/two/one" , " */one" , and so forth.< br >
< br >
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 >
< p class = "description" > Found node or < code > NULL< / code > < / p >
< 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" >
@ -536,11 +494,7 @@ const char *mxmlGetCDATA (<br>
< dd class = "description" > Node to get< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > CDATA value or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned if the node is not a CDATA element.
< / p >
< p class = "description" > CDATA value or < code > NULL< / code > < / p >
< 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" >
@ -553,12 +507,7 @@ const void *mxmlGetCustom (<br>
< dd class = "description" > Node to get< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Custom value or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned if the node (or its first child) is not a custom
value node.
< / p >
< p class = "description" > Custom value or < code > NULL< / code > < / p >
< 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" >
@ -571,11 +520,7 @@ const char *mxmlGetElement (<br>
< dd class = "description" > Node to get< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Element name or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned if the node is not an element node.
< / p >
< p class = "description" > Element name or < code > NULL< / code > < / p >
< 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" >
@ -588,12 +533,7 @@ const char *mxmlGetElement (<br>
< dd class = "description" > Node to get< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > First child or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned if the node is not an element node or if the node
has no children.
< / p >
< p class = "description" > First child or < code > NULL< / code > < / p >
< 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 >
@ -608,10 +548,6 @@ int mxmlGetInteger (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Integer value or 0< / p >
< h4 class = "discussion" > Discussion< / h4 >
< 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 id = "mxmlGetLastChild" > mxmlGetLastChild< / a > < / h3 >
< p class = "description" > Get the last child of an element node.< / p >
< p class = "code" >
@ -624,12 +560,7 @@ int mxmlGetInteger (<br>
< dd class = "description" > Node to get< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Last child or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned if the node is not an element node or if the node
has no children.
< / p >
< p class = "description" > Last child or < code > NULL< / code > < / p >
< h3 class = "function" > < a id = "mxmlGetNextSibling" > mxmlGetNextSibling< / a > < / h3 >
< p class = "description" > Return the node type...< / p >
< p class = "code" >
@ -658,12 +589,7 @@ const char *mxmlGetOpaque (<br>
< dd class = "description" > Node to get< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Opaque string or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned if the node (or its first child) is not an opaque
value node.
< / p >
< p class = "description" > Opaque string or < code > NULL< / code > < / p >
< 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" >
@ -676,11 +602,7 @@ value node.
< dd class = "description" > Node to get< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Parent node or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned for a root node.
< / p >
< p class = "description" > Parent node or < code > NULL< / code > < / p >
< 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" >
@ -693,11 +615,7 @@ value node.
< dd class = "description" > Node to get< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Previous node or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned if this is the first child for the current parent.
< / p >
< p class = "description" > Previous node or < code > NULL< / code > < / p >
< 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" >
@ -711,10 +629,6 @@ double mxmlGetReal (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Real value or 0.0< / p >
< h4 class = "discussion" > Discussion< / h4 >
< 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 id = "mxmlGetRefCount" > mxmlGetRefCount< / a > < / h3 >
< p class = "description" > Get the current reference (use) count for a node.< / p >
< p class = "code" >
@ -728,12 +642,6 @@ int mxmlGetRefCount (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Reference count< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > The initial reference count of new nodes is 1. Use the < a href = "#mxmlRetain" > < code > mxmlRetain< / code > < / a >
and < a href = "#mxmlRelease" > < code > mxmlRelease< / code > < / a > functions to increment and decrement a node's
reference count.
.< / p >
< 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" >
@ -749,12 +657,7 @@ const char *mxmlGetText (<br>
< dd class = "description" > 1 if string is preceded by whitespace, 0 otherwise< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Text string or NULL< / p >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > < code > NULL< / code > is returned if the node (or its first child) is not a text node.
The " whitespace" argument can be NULL.
< / p >
< p class = "description" > Text string or < code > NULL< / code > < / p >
< 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" >
@ -768,10 +671,6 @@ The "whitespace" argument can be NULL.
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Type of node< / p >
< h4 class = "discussion" > Discussion< / h4 >
< 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 id = "mxmlGetUserData" > mxmlGetUserData< / a > < / h3 >
< p class = "description" > Get the user data pointer for a node.< / p >
< p class = "code" >
@ -808,9 +707,7 @@ void mxmlIndexDelete (<br>
< dd class = "description" > Index to enumerate< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 >
< p class = "description" > Next node or < code > NULL< / code > if there is none< / p >
< h3 class = "function" > < a id = "mxmlIndexFind" > mxmlIndexFind< / a > < / h3 >
< p class = "description" > Find the next matching node.< / p >
< p class = "code" >
@ -829,12 +726,7 @@ void mxmlIndexDelete (<br>
< dd class = "description" > Attribute value, if any< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Node or NULL if none found< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > Node or < code > NULL< / code > if none found< / p >
< 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" >
@ -861,18 +753,12 @@ int mxmlIndexGetCount (<br>
< dt > node< / dt >
< dd class = "description" > XML node tree< / dd >
< dt > element< / dt >
< dd class = "description" > Element to index or NULL for all< / dd >
< dd class = "description" > Element to index or < code > < / code > < / dd >
< dt > attr< / dt >
< dd class = "description" > Attribute to index or NULL for none< / dd >
< dd class = "description" > Attribute to index or < code > < / code > < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New index< / p >
< h4 class = "discussion" > 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 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 >
@ -886,10 +772,7 @@ return the first node in the index.</p>
< dd class = "description" > Index to reset< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > First node or NULL if there is none< / 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 >
< p class = "description" > First node or < code > NULL< / code > if there is none< / p >
< 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" >
@ -905,21 +788,10 @@ mxmlIndexFind() for the first time.</p>
< dt > fd< / dt >
< dd class = "description" > File descriptor to read from< / dd >
< dt > cb< / dt >
< dd class = "description" > Callback function or MXML_NO_CALLBACK < / dd >
< dd class = "description" > Callback function or constant < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > First node or NULL if the file could not be read.< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > First node or < code > NULL< / code > if the file could not be read.< / p >
< h3 class = "function" > < a id = "mxmlLoadFile" > mxmlLoadFile< / a > < / h3 >
< p class = "description" > Load a file into an XML node tree.< / p >
< p class = "code" >
@ -935,21 +807,10 @@ child nodes of the specified type.</p>
< dt > fp< / dt >
< dd class = "description" > File to read from< / dd >
< dt > cb< / dt >
< dd class = "description" > Callback function or MXML_NO_CALLBACK < / dd >
< dd class = "description" > Callback function or constant < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > First node or NULL if the file could not be read.< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > First node or < code > NULL< / code > if the file could not be read.< / p >
< h3 class = "function" > < a id = "mxmlLoadString" > mxmlLoadString< / a > < / h3 >
< p class = "description" > Load a string into an XML node tree.< / p >
< p class = "code" >
@ -965,21 +826,10 @@ child nodes of the specified type.</p>
< dt > s< / dt >
< dd class = "description" > String to load< / dd >
< dt > cb< / dt >
< dd class = "description" > Callback function or MXML_NO_CALLBACK < / dd >
< dd class = "description" > Callback function or constant < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > First node or NULL if the string has errors.< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > First node or < code > NULL< / code > if the string has errors.< / p >
< 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" >
@ -990,19 +840,12 @@ child nodes of the specified type.</p>
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or MXML_NO_PARENT< / dd >
< dd class = "description" > Parent node or < code > < / code > < / dd >
< dt > data< / dt >
< dd class = "description" > Data string< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h4 class = "discussion" > 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 id = "mxmlNewCustom" > mxmlNewCustom< / a > < / h3 >
< p class = "description" > Create a new custom data node.< / p >
< p class = "code" >
@ -1014,7 +857,7 @@ is copied into the new node. CDATA nodes use the MXML_ELEMENT type.
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or MXML_NO_PARENT< / dd >
< dd class = "description" > Parent node or < code > < / code > < / dd >
< dt > data< / dt >
< dd class = "description" > Pointer to data< / dd >
< dt > destroy< / dt >
@ -1022,13 +865,6 @@ is copied into the new node. CDATA nodes use the MXML_ELEMENT type.
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h4 class = "discussion" > 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 id = "mxmlNewElement" > mxmlNewElement< / a > < / h3 >
< p class = "description" > Create a new element node.< / p >
< p class = "code" >
@ -1039,16 +875,12 @@ node is not dynamically allocated or is separately managed.
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or MXML_NO_PARENT< / dd >
< dd class = "description" > Parent node or < code > < / code > < / dd >
< dt > name< / dt >
< dd class = "description" > Name of element< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h4 class = "discussion" > 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 id = "mxmlNewInteger" > mxmlNewInteger< / a > < / h3 >
< p class = "description" > Create a new integer node.< / p >
< p class = "code" >
@ -1059,16 +891,12 @@ element node has no parent.</p>
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or MXML_NO_PARENT< / dd >
< dd class = "description" > Parent node or < code > < / code > < / dd >
< dt > integer< / dt >
< dd class = "description" > Integer value< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h4 class = "discussion" > 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 id = "mxmlNewOpaque" > mxmlNewOpaque< / a > < / h3 >
< p class = "description" > Create a new opaque string.< / p >
< p class = "code" >
@ -1079,17 +907,31 @@ integer node has no parent.</p>
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or MXML_NO_PARENT< / dd >
< dd class = "description" > Parent node or < code > < / code > < / dd >
< dt > opaque< / dt >
< dd class = "description" > Opaque string< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h4 class = "discussion" > 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 id = "mxmlNewOpaquef" > mxmlNewOpaquef< / a > < / h3 >
< p class = "description" > Create a new formatted opaque string node.< / p >
< p class = "code" >
< a href = "#mxml_node_t" > mxml_node_t< / a > *mxmlNewOpaquef (< br >
        < a href = "#mxml_node_t" > mxml_node_t< / a > *parent,< br >
        const char *format,< br >
        ...< br >
);< / p >
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or < code > MXML_NO_PARENT< / code > < / dd >
< dt > format< / dt >
< dd class = "description" > Printf-style format string< / dd >
< dt > ...< / dt >
< dd class = "description" > Additional args as needed< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h3 class = "function" > < a id = "mxmlNewReal" > mxmlNewReal< / a > < / h3 >
< p class = "description" > Create a new real number node.< / p >
< p class = "code" >
@ -1100,16 +942,12 @@ is copied into the new node.</p>
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or MXML_NO_PARENT< / dd >
< dd class = "description" > Parent node or < code > < / code > < / dd >
< dt > real< / dt >
< dd class = "description" > Real number value< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h4 class = "discussion" > 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 id = "mxmlNewText" > mxmlNewText< / a > < / h3 >
< p class = "description" > Create a new text fragment node.< / p >
< p class = "code" >
@ -1121,7 +959,7 @@ the new real number node has no parent.</p>
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or MXML_NO_PARENT< / dd >
< dd class = "description" > Parent node or < code > < / code > < / dd >
< dt > whitespace< / dt >
< dd class = "description" > 1 = leading whitespace, 0 = no whitespace< / dd >
< dt > string< / dt >
@ -1129,12 +967,6 @@ the new real number node has no parent.</p>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h4 class = "discussion" > 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 id = "mxmlNewTextf" > mxmlNewTextf< / a > < / h3 >
< p class = "description" > Create a new formatted text fragment node.< / p >
< p class = "code" >
@ -1147,22 +979,16 @@ string must be nul-terminated and is copied into the new node.</p>
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > parent< / dt >
< dd class = "description" > Parent node or MXML_NO_PARENT< / dd >
< dd class = "description" > Parent node or < code > < / code > < / dd >
< dt > whitespace< / dt >
< dd class = "description" > 1 = leading whitespace, 0 = no whitespace< / dd >
< dt > format< / dt >
< dd class = "description" > Printf-style frmat string< / dd >
< dd class = "description" > Printf-style fo rmat string< / dd >
< dt > ...< / dt >
< dd class = "description" > Additional args as needed< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New node< / p >
< h4 class = "discussion" > 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 id = "mxmlNewXML" > mxmlNewXML< / a > < / h3 >
< p class = "description" > Create a new XML document tree.< / p >
< p class = "code" >
@ -1176,11 +1002,6 @@ string must be nul-terminated and is formatted into the new node.</p>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New ?xml node< / p >
< h4 class = "discussion" > 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 id = "mxmlRelease" > mxmlRelease< / a > < / h3 >
< p class = "description" > Release a node.< / p >
< p class = "code" >
@ -1194,11 +1015,6 @@ int mxmlRelease (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > New reference count< / p >
< h4 class = "discussion" > 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 id = "mxmlRemove" > mxmlRemove< / a > < / h3 >
< p class = "description" > Remove a node from its parent.< / p >
< p class = "code" >
@ -1210,9 +1026,6 @@ void mxmlRemove (<br>
< dt > node< / dt >
< dd class = "description" > Node to remove< / dd >
< / dl >
< 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 id = "mxmlRetain" > mxmlRetain< / a > < / h3 >
< p class = "description" > Retain a node.< / p >
< p class = "code" >
@ -1244,31 +1057,14 @@ using a SAX callback.</p>
< dt > fd< / dt >
< dd class = "description" > File descriptor to read from< / dd >
< dt > cb< / dt >
< dd class = "description" > Callback function or MXML_NO_CALLBACK < / dd >
< dd class = "description" > Callback function or constant < / dd >
< dt > sax_cb< / dt >
< dd class = "description" > SAX callback or MXML_NO_CALLBACK< / dd >
< dd class = "description" > SAX callback or < code > < / code > < / dd >
< dt > sax_data< / dt >
< dd class = "description" > SAX user data< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > First node or NULL if the file could not be read.< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > First node or < code > NULL< / code > if the file could not be read.< / p >
< 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 >
@ -1287,31 +1083,14 @@ using a SAX callback.</p>
< dt > fp< / dt >
< dd class = "description" > File to read from< / dd >
< dt > cb< / dt >
< dd class = "description" > Callback function or MXML_NO_CALLBACK < / dd >
< dd class = "description" > Callback function or constant < / dd >
< dt > sax_cb< / dt >
< dd class = "description" > SAX callback or MXML_NO_CALLBACK< / dd >
< dd class = "description" > SAX callback or < code > < / code > < / dd >
< dt > sax_data< / dt >
< dd class = "description" > SAX user data< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > First node or NULL if the file could not be read.< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > First node or < code > NULL< / code > if the file could not be read.< / p >
< 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 >
@ -1330,31 +1109,14 @@ using a SAX callback.</p>
< dt > s< / dt >
< dd class = "description" > String to load< / dd >
< dt > cb< / dt >
< dd class = "description" > Callback function or MXML_NO_CALLBACK < / dd >
< dd class = "description" > Callback function or constant < / dd >
< dt > sax_cb< / dt >
< dd class = "description" > SAX callback or MXML_NO_CALLBACK< / dd >
< dd class = "description" > SAX callback or < code > < / code > < / dd >
< dt > sax_data< / dt >
< dd class = "description" > SAX user data< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > First node or NULL if the string has errors.< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > First node or < code > NULL< / code > if the string has errors.< / p >
< h3 class = "function" > < a id = "mxmlSaveAllocString" > mxmlSaveAllocString< / a > < / h3 >
< p class = "description" > Save an XML tree to an allocated string.< / p >
< p class = "code" >
@ -1367,22 +1129,10 @@ char *mxmlSaveAllocString (<br>
< dt > node< / dt >
< dd class = "description" > Node to write< / dd >
< dt > cb< / dt >
< dd class = "description" > Whitespace callback or MXML_NO_CALLBACK< / dd >
< dd class = "description" > Whitespace callback or < code > < / code > < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Allocated string or NULL< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > Allocated string or < code > NULL< / code > < / p >
< h3 class = "function" > < a id = "mxmlSaveFd" > mxmlSaveFd< / a > < / h3 >
< p class = "description" > Save an XML tree to a file descriptor.< / p >
< p class = "code" >
@ -1398,16 +1148,10 @@ int mxmlSaveFd (<br>
< dt > fd< / dt >
< dd class = "description" > File descriptor to write to< / dd >
< dt > cb< / dt >
< dd class = "description" > Whitespace callback or MXML_NO_CALLBACK< / dd >
< dd class = "description" > Whitespace callback or < code > < / code > < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > 0 on success, -1 on error.< / p >
< h4 class = "discussion" > 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 id = "mxmlSaveFile" > mxmlSaveFile< / a > < / h3 >
< p class = "description" > Save an XML tree to a file.< / p >
< p class = "code" >
@ -1423,16 +1167,10 @@ int mxmlSaveFile (<br>
< dt > fp< / dt >
< dd class = "description" > File to write to< / dd >
< dt > cb< / dt >
< dd class = "description" > Whitespace callback or MXML_NO_CALLBACK< / dd >
< dd class = "description" > Whitespace callback or < code > < / code > < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > 0 on success, -1 on error.< / p >
< h4 class = "discussion" > 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 id = "mxmlSaveString" > mxmlSaveString< / a > < / h3 >
< p class = "description" > Save an XML node tree to a string.< / p >
< p class = "code" >
@ -1451,20 +1189,10 @@ int mxmlSaveString (<br>
< dt > bufsize< / dt >
< dd class = "description" > Size of string buffer< / dd >
< dt > cb< / dt >
< dd class = "description" > Whitespace callback or MXML_NO_CALLBACK< / dd >
< dd class = "description" > Whitespace callback or < code > < / code > < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Size of string< / p >
< h4 class = "discussion" > 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 id = "mxmlSetCDATA" > mxmlSetCDATA< / a > < / h3 >
< p class = "description" > Set the element name of a CDATA node.< / p >
< p class = "code" >
@ -1481,10 +1209,6 @@ int mxmlSetCDATA (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 CDATA element node.
< / p >
< 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" >
@ -1504,10 +1228,6 @@ int mxmlSetCustom (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 custom node.
< / p >
< h3 class = "function" > < a id = "mxmlSetCustomHandlers" > mxmlSetCustomHandlers< / a > < / h3 >
< p class = "description" > Set the handling functions for custom data.< / p >
< p class = "code" >
@ -1522,12 +1242,6 @@ void mxmlSetCustomHandlers (<br>
< dt > save< / dt >
< dd class = "description" > Save function< / dd >
< / dl >
< h4 class = "discussion" > 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 id = "mxmlSetElement" > mxmlSetElement< / a > < / h3 >
< p class = "description" > Set the name of an element node.< / p >
< p class = "code" >
@ -1544,8 +1258,6 @@ int mxmlSetElement (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 id = "mxmlSetErrorCallback" > mxmlSetErrorCallback< / a > < / h3 >
< p class = "description" > Set the error message callback.< / p >
< p class = "code" >
@ -1573,8 +1285,6 @@ int mxmlSetInteger (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 id = "mxmlSetOpaque" > mxmlSetOpaque< / a > < / h3 >
< p class = "description" > Set the value of an opaque node.< / p >
< p class = "code" >
@ -1591,8 +1301,25 @@ int mxmlSetOpaque (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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" > < span class = "info" >   Mini-XML 2.11  < / span > < a id = "mxmlSetOpaquef" > mxmlSetOpaquef< / a > < / h3 >
< p class = "description" > Set the value of an opaque string node to a formatted string.< / p >
< p class = "code" >
int mxmlSetOpaquef (< br >
        < a href = "#mxml_node_t" > mxml_node_t< / a > *node,< br >
        const char *format,< br >
        ...< br >
);< / p >
< h4 class = "parameters" > Parameters< / h4 >
< dl >
< dt > node< / dt >
< dd class = "description" > Node to set< / dd >
< dt > format< / dt >
< dd class = "description" > Printf-style format string< / dd >
< dt > ...< / dt >
< dd class = "description" > Additional arguments as needed< / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > 0 on success, -1 on failure< / p >
< h3 class = "function" > < a id = "mxmlSetReal" > mxmlSetReal< / a > < / h3 >
< p class = "description" > Set the value of a real number node.< / p >
< p class = "code" >
@ -1609,8 +1336,6 @@ int mxmlSetReal (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 id = "mxmlSetText" > mxmlSetText< / a > < / h3 >
< p class = "description" > Set the value of a text node.< / p >
< p class = "code" >
@ -1630,8 +1355,6 @@ int mxmlSetText (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 id = "mxmlSetTextf" > mxmlSetTextf< / a > < / h3 >
< p class = "description" > Set the value of a text node to a formatted string.< / p >
< p class = "code" >
@ -1654,8 +1377,6 @@ int mxmlSetTextf (<br>
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< 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 id = "mxmlSetUserData" > mxmlSetUserData< / a > < / h3 >
< p class = "description" > Set the user data pointer for a node.< / p >
< p class = "code" >
@ -1683,10 +1404,6 @@ void mxmlSetWrapMargin (<br>
< dt > column< / dt >
< dd class = "description" > Column for wrapping, 0 to disable wrapping< / dd >
< / dl >
< h4 class = "discussion" > Discussion< / h4 >
< p class = "discussion" > Wrapping is disabled when " column" is 0.
< / p >
< 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" >
@ -1702,14 +1419,10 @@ void mxmlSetWrapMargin (<br>
< dt > top< / dt >
< dd class = "description" > Top node< / dd >
< dt > descend< / dt >
< dd class = "description" > Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST< / dd >
< dd class = "description" > Descend into tree - < code > < / code > < code > < / code > < code > < / code > < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Next node or NULL< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > Next node or < code > NULL< / code > < / p >
< 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" >
@ -1725,14 +1438,10 @@ the node's children.</p>
< dt > top< / dt >
< dd class = "description" > Top node< / dd >
< dt > descend< / dt >
< dd class = "description" > Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST< / dd >
< dd class = "description" > Descend into tree - < code > < / code > < code > < / code > < code > < / code > < / dd >
< / dl >
< h4 class = "returnvalue" > Return Value< / h4 >
< p class = "description" > Previous node or NULL< / p >
< h4 class = "discussion" > 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 >
< p class = "description" > Previous node or < code > NULL< / code > < / p >
< 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 >
Michael Sweet
7 years ago