Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / libxml2 / 272693c7e127a43dbcd5bc39c1cec4bfcdabcd2a / . / doc / html / libxml-DOCBparser.html
blob: 40a1e84b1b0ae5dbd954d3011459089145f476d2 [file] [log] [blame]
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>DOCBparser</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]2 .synopsis, .classsynopsis {
3 background: #eeeeee;
4 border: solid 1px #aaaaaa;
5 padding: 0.5em;
6 }
7 .programlisting {
8 background: #eeeeff;
9 border: solid 1px #aaaaff;
10 padding: 0.5em;
11 }
12 .variablelist {
13 padding: 4px;
14 margin-left: 3em;
15 }
16 .navigation {
17 background: #ffeeee;
18 border: solid 1px #ffaaaa;
19 margin-top: 0.5em;
20 margin-bottom: 0.5em;
21 }
22 .navigation a {
23 color: #770000;
24 }
25 .navigation a:visited {
26 color: #550000;
27 }
28 .navigation .title {
29 font-size: 200%;
30 }
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]31 </style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual"><link rel="up" href="libxml-lib.html" title="Libxml Library Reference"><link rel="previous" href="libxml-globals.html" title="globals"><link rel="next" href="libxml-parserInternals.html" title="parserInternals"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-globals.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="libxml-lib.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">Gnome XML Library Reference Manual</th><td><a accesskey="n" href="libxml-parserInternals.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="libxml-DOCBparser"></a><div class="titlepage"></div><div class="refnamediv"><h2>DOCBparser</h2><p>DOCBparser &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]32
33
34
35typedef <a href="libxml-DOCBparser.html#docbParserCtxt">docbParserCtxt</a>;
36typedef <a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a>;
37typedef <a href="libxml-DOCBparser.html#docbParserNodeInfo">docbParserNodeInfo</a>;
38typedef <a href="libxml-DOCBparser.html#docbSAXHandler">docbSAXHandler</a>;
39typedef <a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a>;
40typedef <a href="libxml-DOCBparser.html#docbParserInput">docbParserInput</a>;
41typedef <a href="libxml-DOCBparser.html#docbParserInputPtr">docbParserInputPtr</a>;
42typedef <a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a>;
43typedef <a href="libxml-DOCBparser.html#docbNodePtr">docbNodePtr</a>;
44int <a href="libxml-DOCBparser.html#docbEncodeEntities">docbEncodeEntities</a> (unsigned char *out,
45 int *outlen,
46 unsigned char *in,
47 int *inlen,
48 int quoteChar);
49<a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> <a href="libxml-DOCBparser.html#docbSAXParseDoc">docbSAXParseDoc</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
50 const char *encoding,
51 <a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
52 void *userData);
53<a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> <a href="libxml-DOCBparser.html#docbParseDoc">docbParseDoc</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
54 const char *encoding);
55<a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> <a href="libxml-DOCBparser.html#docbSAXParseFile">docbSAXParseFile</a> (const char *filename,
56 const char *encoding,
57 <a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
58 void *userData);
59<a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> <a href="libxml-DOCBparser.html#docbParseFile">docbParseFile</a> (const char *filename,
60 const char *encoding);
61void <a href="libxml-DOCBparser.html#docbFreeParserCtxt">docbFreeParserCtxt</a> (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt);
62<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> <a href="libxml-DOCBparser.html#docbCreatePushParserCtxt">docbCreatePushParserCtxt</a> (<a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
63 void *user_data,
64 const char *chunk,
65 int size,
66 const char *filename,
67 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
68int <a href="libxml-DOCBparser.html#docbParseChunk">docbParseChunk</a> (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt,
69 const char *chunk,
70 int size,
71 int terminate);
72<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> <a href="libxml-DOCBparser.html#docbCreateFileParserCtxt">docbCreateFileParserCtxt</a> (const char *filename,
73 const char *encoding);
74int <a href="libxml-DOCBparser.html#docbParseDocument">docbParseDocument</a> (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt);
75</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
76
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]77</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="docbParserCtxt"></a>docbParserCtxt</h3><pre class="programlisting">typedef xmlParserCtxt docbParserCtxt;
78</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]79
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]80</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbParserCtxtPtr"></a>docbParserCtxtPtr</h3><pre class="programlisting">typedef xmlParserCtxtPtr docbParserCtxtPtr;
81</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]82
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]83</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbParserNodeInfo"></a>docbParserNodeInfo</h3><pre class="programlisting">typedef xmlParserNodeInfo docbParserNodeInfo;
84</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]85
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]86</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbSAXHandler"></a>docbSAXHandler</h3><pre class="programlisting">typedef xmlSAXHandler docbSAXHandler;
87</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]88
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]89</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbSAXHandlerPtr"></a>docbSAXHandlerPtr</h3><pre class="programlisting">typedef xmlSAXHandlerPtr docbSAXHandlerPtr;
90</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]91
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]92</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbParserInput"></a>docbParserInput</h3><pre class="programlisting">typedef xmlParserInput docbParserInput;
93</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]94
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]95</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbParserInputPtr"></a>docbParserInputPtr</h3><pre class="programlisting">typedef xmlParserInputPtr docbParserInputPtr;
96</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]97
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]98</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbDocPtr"></a>docbDocPtr</h3><pre class="programlisting">typedef xmlDocPtr docbDocPtr;
99</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]100
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]101</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbNodePtr"></a>docbNodePtr</h3><pre class="programlisting">typedef xmlNodePtr docbNodePtr;
102</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]103
104</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbEncodeEntities"></a>docbEncodeEntities ()</h3><pre class="programlisting">int docbEncodeEntities (unsigned char *out,
105 int *outlen,
106 unsigned char *in,
107 int *inlen,
108 int quoteChar);</pre><p>
109Take a block of UTF-8 chars in and try to convert it to an ASCII
110plus SGML entities block of chars out.</p><p>
111
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]112</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>out</tt></i> :</span></td><td> a pointer to an array of bytes to store the result
113</td></tr><tr><td><span class="term"><i><tt>outlen</tt></i> :</span></td><td> the length of <i><tt>out</tt></i>
114</td></tr><tr><td><span class="term"><i><tt>in</tt></i> :</span></td><td> a pointer to an array of UTF-8 chars
115</td></tr><tr><td><span class="term"><i><tt>inlen</tt></i> :</span></td><td> the length of <i><tt>in</tt></i>
116</td></tr><tr><td><span class="term"><i><tt>quoteChar</tt></i> :</span></td><td> the quote character to escape (' or ") or zero.
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]117</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if success, -2 if the transcoding fails, or -1 otherwise
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]118The value of <i><tt>inlen</tt></i> after return is the number of octets consumed
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]119 as the return value is positive, else unpredictable.
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]120The value of <i><tt>outlen</tt></i> after return is the number of octets consumed.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]121</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbSAXParseDoc"></a>docbSAXParseDoc ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> docbSAXParseDoc (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
122 const char *encoding,
123 <a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
124 void *userData);</pre><p>
125parse an SGML in-memory document and build a tree.
126It use the given SAX function block to handle the parsing callback.
127If sax is NULL, fallback to the default DOM tree building routines.</p><p>
128
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]129</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>cur</tt></i> :</span></td><td> a pointer to an array of xmlChar
130</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i> :</span></td><td> a free form C string describing the SGML document encoding, or NULL
131</td></tr><tr><td><span class="term"><i><tt>sax</tt></i> :</span></td><td> the SAX handler block
132</td></tr><tr><td><span class="term"><i><tt>userData</tt></i> :</span></td><td> if using SAX, this pointer will be provided on callbacks.
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]133</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]134</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbParseDoc"></a>docbParseDoc ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> docbParseDoc (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
135 const char *encoding);</pre><p>
136parse an SGML in-memory document and build a tree.</p><p>
137
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]138</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>cur</tt></i> :</span></td><td> a pointer to an array of xmlChar
139</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i> :</span></td><td> a free form C string describing the SGML document encoding, or NULL
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]140</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]141</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbSAXParseFile"></a>docbSAXParseFile ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> docbSAXParseFile (const char *filename,
142 const char *encoding,
143 <a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
144 void *userData);</pre><p>
145parse an SGML file and build a tree. Automatic support for ZLIB/Compress
146compressed document is provided by default if found at compile-time.
147It use the given SAX function block to handle the parsing callback.
148If sax is NULL, fallback to the default DOM tree building routines.</p><p>
149
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]150</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the filename
151</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i> :</span></td><td> a free form C string describing the SGML document encoding, or NULL
152</td></tr><tr><td><span class="term"><i><tt>sax</tt></i> :</span></td><td> the SAX handler block
153</td></tr><tr><td><span class="term"><i><tt>userData</tt></i> :</span></td><td> if using SAX, this pointer will be provided on callbacks.
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]154</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]155</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbParseFile"></a>docbParseFile ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> docbParseFile (const char *filename,
156 const char *encoding);</pre><p>
157parse a Docbook SGML file and build a tree. Automatic support for
158ZLIB/Compress compressed document is provided by default if found
159at compile-time.</p><p>
160
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]161</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the filename
162</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i> :</span></td><td> a free form C string describing document encoding, or NULL
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]163</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]164</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbFreeParserCtxt"></a>docbFreeParserCtxt ()</h3><pre class="programlisting">void docbFreeParserCtxt (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt);</pre><p>
165Free all the memory used by a parser context. However the parsed
166document in ctxt-&gt;myDoc is not freed.</p><p>
167
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]168</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an SGML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]169</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbCreatePushParserCtxt"></a>docbCreatePushParserCtxt ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> docbCreatePushParserCtxt (<a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
170 void *user_data,
171 const char *chunk,
172 int size,
173 const char *filename,
174 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
175Create a parser context for using the DocBook SGML parser in push mode
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]176To allow content encoding detection, <i><tt>size</tt></i> should be &gt;= 4
177The value of <i><tt>filename</tt></i> is used for fetching external entities
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]178and error/warning reports.</p><p>
179
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]180</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>sax</tt></i> :</span></td><td> a SAX handler
181</td></tr><tr><td><span class="term"><i><tt>user_data</tt></i> :</span></td><td> The user data returned on SAX callbacks
182</td></tr><tr><td><span class="term"><i><tt>chunk</tt></i> :</span></td><td> a pointer to an array of chars
183</td></tr><tr><td><span class="term"><i><tt>size</tt></i> :</span></td><td> number of chars in the array
184</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> an optional file name or URI
185</td></tr><tr><td><span class="term"><i><tt>enc</tt></i> :</span></td><td> an optional encoding
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]186</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]187</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbParseChunk"></a>docbParseChunk ()</h3><pre class="programlisting">int docbParseChunk (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt,
188 const char *chunk,
189 int size,
190 int terminate);</pre><p>
191Parse a Chunk of memory</p><p>
192
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]193</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
194</td></tr><tr><td><span class="term"><i><tt>chunk</tt></i> :</span></td><td> an char array
195</td></tr><tr><td><span class="term"><i><tt>size</tt></i> :</span></td><td> the size in byte of the chunk
196</td></tr><tr><td><span class="term"><i><tt>terminate</tt></i> :</span></td><td> last chunk indicator
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]197</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>zero if no error, the xmlParserErrors otherwise.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]198</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbCreateFileParserCtxt"></a>docbCreateFileParserCtxt ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> docbCreateFileParserCtxt (const char *filename,
199 const char *encoding);</pre><p>
200Create a parser context for a file content.
201Automatic support for ZLIB/Compress compressed document is provided
202by default if found at compile-time.</p><p>
203
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]204</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the filename
205</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i> :</span></td><td> the SGML document encoding, or NULL
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]206</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]207</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbParseDocument"></a>docbParseDocument ()</h3><pre class="programlisting">int docbParseDocument (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt);</pre><p>
208parse an SGML document (and build a tree if using the standard SAX
209interface).</p><p>
210
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]211</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an SGML parser context
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]212</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0, -1 in case of error. the parser context is augmented
213 as a result of the parsing.
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]214</td></tr></tbody></table></div></div></div></div><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-globals.html"><b>&lt;&lt; globals</b></a></td><td align="right"><a accesskey="n" href="libxml-parserInternals.html"><b>parserInternals &gt;&gt;</b></a></td></tr></table></body></html>