mxml/www/docfiles/mxmlLoadFile.html
Michael R Sweet 6a062afd64 Documentation.
Tweek look-n-feel.

Fix comment editing.

Use format_text() for comments, too.
2004-05-19 16:34:55 +00:00

71 lines
2.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<TITLE>Mini-XML Programmers Manual, Version 2.0</TITLE>
<META NAME="author" CONTENT="Michael Sweet">
<META NAME="copyright" CONTENT="Copyright 2003-2004">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-iso-8859-1">
<LINK REL="Start" HREF="index.html">
<LINK REL="Contents" HREF="toc.html">
<LINK REL="Prev" HREF="mxmlIndexReset.html">
<LINK REL="Next" HREF="mxmlLoadString.html">
<STYLE TYPE="text/css"><!--
BODY { font-family: serif }
H1 { font-family: sans-serif }
H2 { font-family: sans-serif }
H3 { font-family: sans-serif }
H4 { font-family: sans-serif }
H5 { font-family: sans-serif }
H6 { font-family: sans-serif }
SUB { font-size: smaller }
SUP { font-size: smaller }
PRE { font-family: monospace }
--></STYLE>
</HEAD>
<BODY>
<A HREF="toc.html">Contents</A>
<A HREF="mxmlIndexReset.html">Previous</A>
<A HREF="mxmlLoadString.html">Next</A>
<HR NOSHADE>
<H3><A name="mxmlLoadFile">mxmlLoadFile()</A></H3>
<HR noshade/>
<H4>Description</H4>
<P>Load a file into an XML node tree. 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 &lt;?xml&gt; 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. 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>
<H4>Syntax</H4>
<PRE>
<A href="mxmlnodet.html#mxml_node_t">mxml_node_t</A> *
mxmlLoadFile(
<A href="mxmlnodet.html#mxml_node_t">mxml_node_t</A> * top,
FILE * fp,
<A href="mxmltypet.html#mxml_type_t">mxml_type_t</A> (*cb)(mxml_node_t *node));
</PRE>
<H4>Arguments</H4>
<P class="table"></P>
<TABLE align="center" border="1" cellpadding="5" cellspacing="0" width="80%">
<THEAD></THEAD>
<TR bgcolor="#cccccc"><TH>Name</TH><TH>Description</TH></TR>
<TBODY></TBODY>
<TR><TD><TT>top</TT></TD><TD>Top node</TD></TR>
<TR><TD><TT>fp</TT></TD><TD>File to read from</TD></TR>
<TR><TD><TT>(*cb)(mxml_node_t *node)</TT></TD><TD>Callback function or
MXML_NO_CALLBACK</TD></TR>
</TABLE>
<H4>Returns</H4>
<P>First node or NULL if the file could not be read.</P>
<!-- NEW PAGE -->
<HR NOSHADE>
<A HREF="toc.html">Contents</A>
<A HREF="mxmlIndexReset.html">Previous</A>
<A HREF="mxmlLoadString.html">Next</A>
</BODY>
</HTML>