| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <html>
|
|---|
| 3 | <head>
|
|---|
| 4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|---|
| 5 | <title>xinclude: implementation of XInclude</title>
|
|---|
| 6 | <meta name="generator" content="Libxml2 devhelp stylesheet"/>
|
|---|
| 7 | <link rel="start" href="index.html" title="libxml2 Reference Manual"/>
|
|---|
| 8 | <link rel="up" href="general.html" title="API"/>
|
|---|
| 9 | <link rel="stylesheet" href="style.css" type="text/css"/>
|
|---|
| 10 | <link rel="chapter" href="general.html" title="API"/>
|
|---|
| 11 | </head>
|
|---|
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|---|
| 13 | <table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
|---|
| 14 | <tr valign="middle">
|
|---|
| 15 | <td>
|
|---|
| 16 | <a accesskey="p" href="libxml2-valid.html">
|
|---|
| 17 | <img src="left.png" width="24" height="24" border="0" alt="Prev"/>
|
|---|
| 18 | </a>
|
|---|
| 19 | </td>
|
|---|
| 20 | <td>
|
|---|
| 21 | <a accesskey="u" href="general.html">
|
|---|
| 22 | <img src="up.png" width="24" height="24" border="0" alt="Up"/>
|
|---|
| 23 | </a>
|
|---|
| 24 | </td>
|
|---|
| 25 | <td>
|
|---|
| 26 | <a accesskey="h" href="index.html">
|
|---|
| 27 | <img src="home.png" width="24" height="24" border="0" alt="Home"/>
|
|---|
| 28 | </a>
|
|---|
| 29 | </td>
|
|---|
| 30 | <td>
|
|---|
| 31 | <a accesskey="n" href="libxml2-xlink.html">
|
|---|
| 32 | <img src="right.png" width="24" height="24" border="0" alt="Next"/>
|
|---|
| 33 | </a>
|
|---|
| 34 | </td>
|
|---|
| 35 | <th width="100%" align="center">libxml2 Reference Manual</th>
|
|---|
| 36 | </tr>
|
|---|
| 37 | </table>
|
|---|
| 38 | <h2>
|
|---|
| 39 | <span class="refentrytitle">xinclude</span>
|
|---|
| 40 | </h2>
|
|---|
| 41 | <p>xinclude - implementation of XInclude</p>
|
|---|
| 42 | <p>API to handle XInclude processing, implements the World Wide Web Consortium Last Call Working Draft 10 November 2003</p>
|
|---|
| 43 | <p>Author(s): Daniel Veillard </p>
|
|---|
| 44 | <div class="refsynopsisdiv">
|
|---|
| 45 | <h2>Synopsis</h2>
|
|---|
| 46 | <pre class="synopsis">#define <a href="#XINCLUDE_PARSE_TEXT">XINCLUDE_PARSE_TEXT</a>;
|
|---|
| 47 | #define <a href="#XINCLUDE_PARSE_XPOINTER">XINCLUDE_PARSE_XPOINTER</a>;
|
|---|
| 48 | #define <a href="#XINCLUDE_HREF">XINCLUDE_HREF</a>;
|
|---|
| 49 | #define <a href="#XINCLUDE_FALLBACK">XINCLUDE_FALLBACK</a>;
|
|---|
| 50 | #define <a href="#XINCLUDE_NS">XINCLUDE_NS</a>;
|
|---|
| 51 | #define <a href="#XINCLUDE_PARSE">XINCLUDE_PARSE</a>;
|
|---|
| 52 | #define <a href="#XINCLUDE_NODE">XINCLUDE_NODE</a>;
|
|---|
| 53 | #define <a href="#XINCLUDE_PARSE_XML">XINCLUDE_PARSE_XML</a>;
|
|---|
| 54 | #define <a href="#XINCLUDE_PARSE_ENCODING">XINCLUDE_PARSE_ENCODING</a>;
|
|---|
| 55 | #define <a href="#XINCLUDE_OLD_NS">XINCLUDE_OLD_NS</a>;
|
|---|
| 56 | typedef struct _xmlXIncludeCtxt <a href="#xmlXIncludeCtxt">xmlXIncludeCtxt</a>;
|
|---|
| 57 | typedef <a href="libxml2-xinclude.html#xmlXIncludeCtxt">xmlXIncludeCtxt</a> * <a href="#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a>;
|
|---|
| 58 | int <a href="#xmlXIncludeProcessTreeFlagsData">xmlXIncludeProcessTreeFlagsData</a> (<a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> tree, <br/> int flags, <br/> void * data);
|
|---|
| 59 | int <a href="#xmlXIncludeProcessFlagsData">xmlXIncludeProcessFlagsData</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br/> int flags, <br/> void * data);
|
|---|
| 60 | int <a href="#xmlXIncludeProcessFlags">xmlXIncludeProcessFlags</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br/> int flags);
|
|---|
| 61 | int <a href="#xmlXIncludeProcessTree">xmlXIncludeProcessTree</a> (<a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> tree);
|
|---|
| 62 | int <a href="#xmlXIncludeProcessNode">xmlXIncludeProcessNode</a> (<a href="libxml2-xinclude.html#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a> ctxt, <br/> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node);
|
|---|
| 63 | void <a href="#xmlXIncludeFreeContext">xmlXIncludeFreeContext</a> (<a href="libxml2-xinclude.html#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a> ctxt);
|
|---|
| 64 | int <a href="#xmlXIncludeSetFlags">xmlXIncludeSetFlags</a> (<a href="libxml2-xinclude.html#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a> ctxt, <br/> int flags);
|
|---|
| 65 | int <a href="#xmlXIncludeProcess">xmlXIncludeProcess</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc);
|
|---|
| 66 | <a href="libxml2-xinclude.html#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a> <a href="#xmlXIncludeNewContext">xmlXIncludeNewContext</a> (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc);
|
|---|
| 67 | int <a href="#xmlXIncludeProcessTreeFlags">xmlXIncludeProcessTreeFlags</a> (<a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> tree, <br/> int flags);
|
|---|
| 68 | </pre>
|
|---|
| 69 | </div>
|
|---|
| 70 | <div class="refsect1" lang="en">
|
|---|
| 71 | <h2>Description</h2>
|
|---|
| 72 | </div>
|
|---|
| 73 | <div class="refsect1" lang="en">
|
|---|
| 74 | <h2>Details</h2>
|
|---|
| 75 | <div class="refsect2" lang="en">
|
|---|
| 76 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_FALLBACK">Macro </a>XINCLUDE_FALLBACK</h3><pre class="programlisting">#define <a href="#XINCLUDE_FALLBACK">XINCLUDE_FALLBACK</a>;
|
|---|
| 77 | </pre><p>Macro defining "fallback"</p>
|
|---|
| 78 | </div>
|
|---|
| 79 | <hr/>
|
|---|
| 80 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_HREF">Macro </a>XINCLUDE_HREF</h3><pre class="programlisting">#define <a href="#XINCLUDE_HREF">XINCLUDE_HREF</a>;
|
|---|
| 81 | </pre><p>Macro defining "href"</p>
|
|---|
| 82 | </div>
|
|---|
| 83 | <hr/>
|
|---|
| 84 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_NODE">Macro </a>XINCLUDE_NODE</h3><pre class="programlisting">#define <a href="#XINCLUDE_NODE">XINCLUDE_NODE</a>;
|
|---|
| 85 | </pre><p>Macro defining "include"</p>
|
|---|
| 86 | </div>
|
|---|
| 87 | <hr/>
|
|---|
| 88 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_NS">Macro </a>XINCLUDE_NS</h3><pre class="programlisting">#define <a href="#XINCLUDE_NS">XINCLUDE_NS</a>;
|
|---|
| 89 | </pre><p>Macro defining the Xinclude namespace: http://www.w3.org/2003/XInclude</p>
|
|---|
| 90 | </div>
|
|---|
| 91 | <hr/>
|
|---|
| 92 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_OLD_NS">Macro </a>XINCLUDE_OLD_NS</h3><pre class="programlisting">#define <a href="#XINCLUDE_OLD_NS">XINCLUDE_OLD_NS</a>;
|
|---|
| 93 | </pre><p>Macro defining the draft Xinclude namespace: http://www.w3.org/2001/XInclude</p>
|
|---|
| 94 | </div>
|
|---|
| 95 | <hr/>
|
|---|
| 96 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_PARSE">Macro </a>XINCLUDE_PARSE</h3><pre class="programlisting">#define <a href="#XINCLUDE_PARSE">XINCLUDE_PARSE</a>;
|
|---|
| 97 | </pre><p>Macro defining "parse"</p>
|
|---|
| 98 | </div>
|
|---|
| 99 | <hr/>
|
|---|
| 100 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_PARSE_ENCODING">Macro </a>XINCLUDE_PARSE_ENCODING</h3><pre class="programlisting">#define <a href="#XINCLUDE_PARSE_ENCODING">XINCLUDE_PARSE_ENCODING</a>;
|
|---|
| 101 | </pre><p>Macro defining "encoding"</p>
|
|---|
| 102 | </div>
|
|---|
| 103 | <hr/>
|
|---|
| 104 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_PARSE_TEXT">Macro </a>XINCLUDE_PARSE_TEXT</h3><pre class="programlisting">#define <a href="#XINCLUDE_PARSE_TEXT">XINCLUDE_PARSE_TEXT</a>;
|
|---|
| 105 | </pre><p>Macro defining "text"</p>
|
|---|
| 106 | </div>
|
|---|
| 107 | <hr/>
|
|---|
| 108 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_PARSE_XML">Macro </a>XINCLUDE_PARSE_XML</h3><pre class="programlisting">#define <a href="#XINCLUDE_PARSE_XML">XINCLUDE_PARSE_XML</a>;
|
|---|
| 109 | </pre><p>Macro defining "xml"</p>
|
|---|
| 110 | </div>
|
|---|
| 111 | <hr/>
|
|---|
| 112 | <div class="refsect2" lang="en"><h3><a name="XINCLUDE_PARSE_XPOINTER">Macro </a>XINCLUDE_PARSE_XPOINTER</h3><pre class="programlisting">#define <a href="#XINCLUDE_PARSE_XPOINTER">XINCLUDE_PARSE_XPOINTER</a>;
|
|---|
| 113 | </pre><p>Macro defining "xpointer"</p>
|
|---|
| 114 | </div>
|
|---|
| 115 | <hr/>
|
|---|
| 116 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeCtxt">Structure </a>xmlXIncludeCtxt</h3><pre class="programlisting">struct _xmlXIncludeCtxt {
|
|---|
| 117 | The content of this structure is not made public by the API.
|
|---|
| 118 | } xmlXIncludeCtxt;
|
|---|
| 119 | </pre><p/>
|
|---|
| 120 | </div>
|
|---|
| 121 | <hr/>
|
|---|
| 122 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeCtxtPtr">Typedef </a>xmlXIncludeCtxtPtr</h3><pre class="programlisting"><a href="libxml2-xinclude.html#xmlXIncludeCtxt">xmlXIncludeCtxt</a> * xmlXIncludeCtxtPtr;
|
|---|
| 123 | </pre><p/>
|
|---|
| 124 | </div>
|
|---|
| 125 | <hr/>
|
|---|
| 126 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeFreeContext"/>xmlXIncludeFreeContext ()</h3><pre class="programlisting">void xmlXIncludeFreeContext (<a href="libxml2-xinclude.html#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a> ctxt)<br/>
|
|---|
| 127 | </pre><p>Free an XInclude context</p>
|
|---|
| 128 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>the XInclude context</td></tr></tbody></table></div></div>
|
|---|
| 129 | <hr/>
|
|---|
| 130 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeNewContext"/>xmlXIncludeNewContext ()</h3><pre class="programlisting"><a href="libxml2-xinclude.html#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a> xmlXIncludeNewContext (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc)<br/>
|
|---|
| 131 | </pre><p>Creates a new XInclude context</p>
|
|---|
| 132 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>doc</tt></i>:</span></td><td>an XML Document</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>the new set</td></tr></tbody></table></div></div>
|
|---|
| 133 | <hr/>
|
|---|
| 134 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeProcess"/>xmlXIncludeProcess ()</h3><pre class="programlisting">int xmlXIncludeProcess (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc)<br/>
|
|---|
| 135 | </pre><p>Implement the XInclude substitution on the XML document @doc</p>
|
|---|
| 136 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>doc</tt></i>:</span></td><td>an XML document</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no substitution were done, -1 if some processing failed or the number of substitutions done.</td></tr></tbody></table></div></div>
|
|---|
| 137 | <hr/>
|
|---|
| 138 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeProcessFlags"/>xmlXIncludeProcessFlags ()</h3><pre class="programlisting">int xmlXIncludeProcessFlags (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br/> int flags)<br/>
|
|---|
| 139 | </pre><p>Implement the XInclude substitution on the XML document @doc</p>
|
|---|
| 140 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>doc</tt></i>:</span></td><td>an XML document</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>a set of <a href="libxml2-parser.html#xmlParserOption">xmlParserOption</a> used for parsing XML includes</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no substitution were done, -1 if some processing failed or the number of substitutions done.</td></tr></tbody></table></div></div>
|
|---|
| 141 | <hr/>
|
|---|
| 142 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeProcessFlagsData"/>xmlXIncludeProcessFlagsData ()</h3><pre class="programlisting">int xmlXIncludeProcessFlagsData (<a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <br/> int flags, <br/> void * data)<br/>
|
|---|
| 143 | </pre><p>Implement the XInclude substitution on the XML document @doc</p>
|
|---|
| 144 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>doc</tt></i>:</span></td><td>an XML document</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>a set of <a href="libxml2-parser.html#xmlParserOption">xmlParserOption</a> used for parsing XML includes</td></tr><tr><td><span class="term"><i><tt>data</tt></i>:</span></td><td>application data that will be passed to the parser context in the _private field of the parser context(s)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no substitution were done, -1 if some processing failed or the number of substitutions done.</td></tr></tbody></table></div></div>
|
|---|
| 145 | <hr/>
|
|---|
| 146 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeProcessNode"/>xmlXIncludeProcessNode ()</h3><pre class="programlisting">int xmlXIncludeProcessNode (<a href="libxml2-xinclude.html#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a> ctxt, <br/> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node)<br/>
|
|---|
| 147 | </pre><p>Implement the XInclude substitution for the given subtree reusing the informations and data coming from the given context.</p>
|
|---|
| 148 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>an existing XInclude context</td></tr><tr><td><span class="term"><i><tt>node</tt></i>:</span></td><td>a node in an XML document</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no substitution were done, -1 if some processing failed or the number of substitutions done.</td></tr></tbody></table></div></div>
|
|---|
| 149 | <hr/>
|
|---|
| 150 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeProcessTree"/>xmlXIncludeProcessTree ()</h3><pre class="programlisting">int xmlXIncludeProcessTree (<a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> tree)<br/>
|
|---|
| 151 | </pre><p>Implement the XInclude substitution for the given subtree</p>
|
|---|
| 152 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>tree</tt></i>:</span></td><td>a node in an XML document</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no substitution were done, -1 if some processing failed or the number of substitutions done.</td></tr></tbody></table></div></div>
|
|---|
| 153 | <hr/>
|
|---|
| 154 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeProcessTreeFlags"/>xmlXIncludeProcessTreeFlags ()</h3><pre class="programlisting">int xmlXIncludeProcessTreeFlags (<a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> tree, <br/> int flags)<br/>
|
|---|
| 155 | </pre><p>Implement the XInclude substitution for the given subtree</p>
|
|---|
| 156 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>tree</tt></i>:</span></td><td>a node in an XML document</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>a set of <a href="libxml2-parser.html#xmlParserOption">xmlParserOption</a> used for parsing XML includes</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no substitution were done, -1 if some processing failed or the number of substitutions done.</td></tr></tbody></table></div></div>
|
|---|
| 157 | <hr/>
|
|---|
| 158 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeProcessTreeFlagsData"/>xmlXIncludeProcessTreeFlagsData ()</h3><pre class="programlisting">int xmlXIncludeProcessTreeFlagsData (<a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> tree, <br/> int flags, <br/> void * data)<br/>
|
|---|
| 159 | </pre><p>Implement the XInclude substitution on the XML node @tree</p>
|
|---|
| 160 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>tree</tt></i>:</span></td><td>an XML node</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>a set of <a href="libxml2-parser.html#xmlParserOption">xmlParserOption</a> used for parsing XML includes</td></tr><tr><td><span class="term"><i><tt>data</tt></i>:</span></td><td>application data that will be passed to the parser context in the _private field of the parser context(s)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 if no substitution were done, -1 if some processing failed or the number of substitutions done.</td></tr></tbody></table></div></div>
|
|---|
| 161 | <hr/>
|
|---|
| 162 | <div class="refsect2" lang="en"><h3><a name="xmlXIncludeSetFlags"/>xmlXIncludeSetFlags ()</h3><pre class="programlisting">int xmlXIncludeSetFlags (<a href="libxml2-xinclude.html#xmlXIncludeCtxtPtr">xmlXIncludeCtxtPtr</a> ctxt, <br/> int flags)<br/>
|
|---|
| 163 | </pre><p>Set the flags used for further processing of XML resources.</p>
|
|---|
| 164 | <div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td>an XInclude processing context</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>a set of <a href="libxml2-parser.html#xmlParserOption">xmlParserOption</a> used for parsing XML includes</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of error.</td></tr></tbody></table></div></div>
|
|---|
| 165 | <hr/>
|
|---|
| 166 | </div>
|
|---|
| 167 | </div>
|
|---|
| 168 | </body>
|
|---|
| 169 | </html>
|
|---|
