blob: 704e18cf5936cc167ff7c41c90ce226aa4095580 [file] [log] [blame]
Daniel Veillard2fdbd322003-08-18 12:15:38 +00001<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlIO</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 +00002 .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 +000031 </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-nanoftp.html" title="nanoftp"><link rel="next" href="libxml-catalog.html" title="catalog"></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-nanoftp.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-catalog.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-xmlIO"></a><div class="titlepage"></div><div class="refnamediv"><h2>xmlIO</h2><p>xmlIO &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
Daniel Veillardd4330462003-04-29 12:40:16 +000032
33
34
35int (<a href="libxml-xmlIO.html#xmlInputMatchCallback">*xmlInputMatchCallback</a>) (char const *filename);
36void* (<a href="libxml-xmlIO.html#xmlInputOpenCallback">*xmlInputOpenCallback</a>) (char const *filename);
37int (<a href="libxml-xmlIO.html#xmlInputReadCallback">*xmlInputReadCallback</a>) (void *context,
38 char *buffer,
39 int len);
40int (<a href="libxml-xmlIO.html#xmlInputCloseCallback">*xmlInputCloseCallback</a>) (void *context);
41int (<a href="libxml-xmlIO.html#xmlOutputMatchCallback">*xmlOutputMatchCallback</a>) (char const *filename);
42void* (<a href="libxml-xmlIO.html#xmlOutputOpenCallback">*xmlOutputOpenCallback</a>) (char const *filename);
43int (<a href="libxml-xmlIO.html#xmlOutputWriteCallback">*xmlOutputWriteCallback</a>) (void *context,
44 const char *buffer,
45 int len);
46int (<a href="libxml-xmlIO.html#xmlOutputCloseCallback">*xmlOutputCloseCallback</a>) (void *context);
Daniel Veillard2fdbd322003-08-18 12:15:38 +000047struct <a href="libxml-tree.html#xmlParserInputBuffer">xmlParserInputBuffer</a>;
48struct <a href="libxml-tree.html#xmlOutputBuffer">xmlOutputBuffer</a>;
Daniel Veillardd4330462003-04-29 12:40:16 +000049void <a href="libxml-xmlIO.html#xmlCleanupInputCallbacks">xmlCleanupInputCallbacks</a> (void);
50void <a href="libxml-xmlIO.html#xmlCleanupOutputCallbacks">xmlCleanupOutputCallbacks</a> (void);
51void <a href="libxml-xmlIO.html#xmlRegisterDefaultInputCallbacks">xmlRegisterDefaultInputCallbacks</a>
52 (void);
53<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> <a href="libxml-xmlIO.html#xmlAllocParserInputBuffer">xmlAllocParserInputBuffer</a>
54 (<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
55<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> <a href="libxml-xmlIO.html#xmlParserInputBufferCreateFilename">xmlParserInputBufferCreateFilename</a>
56 (const char *URI,
57 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
58<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> <a href="libxml-xmlIO.html#xmlParserInputBufferCreateFile">xmlParserInputBufferCreateFile</a>
59 (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *file,
60 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
61<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> <a href="libxml-xmlIO.html#xmlParserInputBufferCreateFd">xmlParserInputBufferCreateFd</a>
62 (int fd,
63 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
64<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> <a href="libxml-xmlIO.html#xmlParserInputBufferCreateMem">xmlParserInputBufferCreateMem</a>
65 (const char *mem,
66 int size,
67 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
68<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> <a href="libxml-xmlIO.html#xmlParserInputBufferCreateIO">xmlParserInputBufferCreateIO</a>
69 (<a href="libxml-xmlIO.html#xmlInputReadCallback">xmlInputReadCallback</a> ioread,
70 <a href="libxml-xmlIO.html#xmlInputCloseCallback">xmlInputCloseCallback</a> ioclose,
71 void *ioctx,
72 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
73int <a href="libxml-xmlIO.html#xmlParserInputBufferRead">xmlParserInputBufferRead</a> (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> in,
74 int len);
75int <a href="libxml-xmlIO.html#xmlParserInputBufferGrow">xmlParserInputBufferGrow</a> (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> in,
76 int len);
77int <a href="libxml-xmlIO.html#xmlParserInputBufferPush">xmlParserInputBufferPush</a> (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> in,
78 int len,
79 const char *buf);
80void <a href="libxml-xmlIO.html#xmlFreeParserInputBuffer">xmlFreeParserInputBuffer</a> (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> in);
81char* <a href="libxml-xmlIO.html#xmlParserGetDirectory">xmlParserGetDirectory</a> (const char *filename);
82int <a href="libxml-xmlIO.html#xmlRegisterInputCallbacks">xmlRegisterInputCallbacks</a> (<a href="libxml-xmlIO.html#xmlInputMatchCallback">xmlInputMatchCallback</a> matchFunc,
83 <a href="libxml-xmlIO.html#xmlInputOpenCallback">xmlInputOpenCallback</a> openFunc,
84 <a href="libxml-xmlIO.html#xmlInputReadCallback">xmlInputReadCallback</a> readFunc,
85 <a href="libxml-xmlIO.html#xmlInputCloseCallback">xmlInputCloseCallback</a> closeFunc);
86void <a href="libxml-xmlIO.html#xmlRegisterDefaultOutputCallbacks">xmlRegisterDefaultOutputCallbacks</a>
87 (void);
88<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> <a href="libxml-xmlIO.html#xmlAllocOutputBuffer">xmlAllocOutputBuffer</a> (<a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder);
89<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> <a href="libxml-xmlIO.html#xmlOutputBufferCreateFilename">xmlOutputBufferCreateFilename</a>
90 (const char *URI,
91 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder,
92 int compression);
93<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> <a href="libxml-xmlIO.html#xmlOutputBufferCreateFile">xmlOutputBufferCreateFile</a>
94 (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *file,
95 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder);
96<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> <a href="libxml-xmlIO.html#xmlOutputBufferCreateFd">xmlOutputBufferCreateFd</a> (int fd,
97 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder);
98<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> <a href="libxml-xmlIO.html#xmlOutputBufferCreateIO">xmlOutputBufferCreateIO</a> (<a href="libxml-xmlIO.html#xmlOutputWriteCallback">xmlOutputWriteCallback</a> iowrite,
99 <a href="libxml-xmlIO.html#xmlOutputCloseCallback">xmlOutputCloseCallback</a> ioclose,
100 void *ioctx,
101 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder);
102int <a href="libxml-xmlIO.html#xmlOutputBufferWrite">xmlOutputBufferWrite</a> (<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> out,
103 int len,
104 const char *buf);
105int <a href="libxml-xmlIO.html#xmlOutputBufferWriteString">xmlOutputBufferWriteString</a> (<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> out,
106 const char *str);
107int <a href="libxml-xmlIO.html#xmlOutputBufferFlush">xmlOutputBufferFlush</a> (<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> out);
108int <a href="libxml-xmlIO.html#xmlOutputBufferClose">xmlOutputBufferClose</a> (<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> out);
109int <a href="libxml-xmlIO.html#xmlRegisterOutputCallbacks">xmlRegisterOutputCallbacks</a> (<a href="libxml-xmlIO.html#xmlOutputMatchCallback">xmlOutputMatchCallback</a> matchFunc,
110 <a href="libxml-xmlIO.html#xmlOutputOpenCallback">xmlOutputOpenCallback</a> openFunc,
111 <a href="libxml-xmlIO.html#xmlOutputWriteCallback">xmlOutputWriteCallback</a> writeFunc,
112 <a href="libxml-xmlIO.html#xmlOutputCloseCallback">xmlOutputCloseCallback</a> closeFunc);
113void* <a href="libxml-xmlIO.html#xmlIOHTTPOpenW">xmlIOHTTPOpenW</a> (const char *post_uri,
114 int compression);
115void <a href="libxml-xmlIO.html#xmlRegisterHTTPPostCallbacks">xmlRegisterHTTPPostCallbacks</a> (void);
116<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-xmlIO.html#xmlNoNetExternalEntityLoader">xmlNoNetExternalEntityLoader</a>
117 (const char *URL,
118 const char *ID,
119 <a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
120<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlIO.html#xmlNormalizeWindowsPath">xmlNormalizeWindowsPath</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *path);
121int <a href="libxml-xmlIO.html#xmlCheckFilename">xmlCheckFilename</a> (const char *path);
122int <a href="libxml-xmlIO.html#xmlFileMatch">xmlFileMatch</a> (const char *filename);
123void* <a href="libxml-xmlIO.html#xmlFileOpen">xmlFileOpen</a> (const char *filename);
124int <a href="libxml-xmlIO.html#xmlFileRead">xmlFileRead</a> (void *context,
125 char *buffer,
126 int len);
127int <a href="libxml-xmlIO.html#xmlFileClose">xmlFileClose</a> (void *context);
128int <a href="libxml-xmlIO.html#xmlIOHTTPMatch">xmlIOHTTPMatch</a> (const char *filename);
129void* <a href="libxml-xmlIO.html#xmlIOHTTPOpen">xmlIOHTTPOpen</a> (const char *filename);
130int <a href="libxml-xmlIO.html#xmlIOHTTPRead">xmlIOHTTPRead</a> (void *context,
131 char *buffer,
132 int len);
133int <a href="libxml-xmlIO.html#xmlIOHTTPClose">xmlIOHTTPClose</a> (void *context);
134int <a href="libxml-xmlIO.html#xmlIOFTPMatch">xmlIOFTPMatch</a> (const char *filename);
135void* <a href="libxml-xmlIO.html#xmlIOFTPOpen">xmlIOFTPOpen</a> (const char *filename);
136int <a href="libxml-xmlIO.html#xmlIOFTPRead">xmlIOFTPRead</a> (void *context,
137 char *buffer,
138 int len);
139int <a href="libxml-xmlIO.html#xmlIOFTPClose">xmlIOFTPClose</a> (void *context);
140</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
141
142</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="xmlInputMatchCallback"></a>xmlInputMatchCallback ()</h3><pre class="programlisting">int (*xmlInputMatchCallback) (char const *filename);</pre><p>
143Callback used in the I/O Input API to detect if the current handler
144can provide input fonctionnalities for this resource.</p><p>
145
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000146</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 or URI
Daniel Veillardd7cec922003-06-13 12:30:10 +0000147</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if yes and 0 if another Input module should be used
Daniel Veillardd4330462003-04-29 12:40:16 +0000148</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInputOpenCallback"></a>xmlInputOpenCallback ()</h3><pre class="programlisting">void* (*xmlInputOpenCallback) (char const *filename);</pre><p>
149Callback used in the I/O Input API to open the resource</p><p>
150
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000151</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 or URI
Daniel Veillardd4330462003-04-29 12:40:16 +0000152</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInputReadCallback"></a>xmlInputReadCallback ()</h3><pre class="programlisting">int (*xmlInputReadCallback) (void *context,
153 char *buffer,
154 int len);</pre><p>
155Callback used in the I/O Input API to read the resource</p><p>
156
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000157</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> an Input context
158</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td> the buffer to store data read
159</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> the length of the buffer in bytes
Daniel Veillardd7cec922003-06-13 12:30:10 +0000160</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of bytes read or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000161</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInputCloseCallback"></a>xmlInputCloseCallback ()</h3><pre class="programlisting">int (*xmlInputCloseCallback) (void *context);</pre><p>
162Callback used in the I/O Input API to close the resource</p><p>
163
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000164</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> an Input context
Daniel Veillardd7cec922003-06-13 12:30:10 +0000165</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000166</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputMatchCallback"></a>xmlOutputMatchCallback ()</h3><pre class="programlisting">int (*xmlOutputMatchCallback) (char const *filename);</pre><p>
167Callback used in the I/O Output API to detect if the current handler
168can provide output fonctionnalities for this resource.</p><p>
169
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000170</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 or URI
Daniel Veillardd7cec922003-06-13 12:30:10 +0000171</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if yes and 0 if another Output module should be used
Daniel Veillardd4330462003-04-29 12:40:16 +0000172</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputOpenCallback"></a>xmlOutputOpenCallback ()</h3><pre class="programlisting">void* (*xmlOutputOpenCallback) (char const *filename);</pre><p>
173Callback used in the I/O Output API to open the resource</p><p>
174
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000175</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 or URI
Daniel Veillardd4330462003-04-29 12:40:16 +0000176</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputWriteCallback"></a>xmlOutputWriteCallback ()</h3><pre class="programlisting">int (*xmlOutputWriteCallback) (void *context,
177 const char *buffer,
178 int len);</pre><p>
179Callback used in the I/O Output API to write to the resource</p><p>
180
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000181</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> an Output context
182</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td> the buffer of data to write
183</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> the length of the buffer in bytes
Daniel Veillardd7cec922003-06-13 12:30:10 +0000184</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of bytes written or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000185</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputCloseCallback"></a>xmlOutputCloseCallback ()</h3><pre class="programlisting">int (*xmlOutputCloseCallback) (void *context);</pre><p>
186Callback used in the I/O Output API to close the resource</p><p>
187
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000188</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> an Output context
Daniel Veillardd7cec922003-06-13 12:30:10 +0000189</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000190</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBuffer"></a>struct xmlParserInputBuffer</h3><pre class="programlisting">struct xmlParserInputBuffer {
191 void* context;
192 xmlInputReadCallback readcallback;
193 xmlInputCloseCallback closecallback;
194
195 xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
196
197 xmlBufferPtr buffer; /* Local buffer encoded in UTF-8 */
198 xmlBufferPtr raw; /* if encoder != NULL buffer for raw input */
199};
200</pre><p>
201
202</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBuffer"></a>struct xmlOutputBuffer</h3><pre class="programlisting">struct xmlOutputBuffer {
203 void* context;
204 xmlOutputWriteCallback writecallback;
205 xmlOutputCloseCallback closecallback;
206
207 xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
208
209 xmlBufferPtr buffer; /* Local buffer encoded in UTF-8 or ISOLatin */
210 xmlBufferPtr conv; /* if encoder != NULL buffer for output */
211 int written; /* total number of byte written */
212};
213</pre><p>
214
215</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCleanupInputCallbacks"></a>xmlCleanupInputCallbacks ()</h3><pre class="programlisting">void xmlCleanupInputCallbacks (void);</pre><p>
216clears the entire input callback table. this includes the
217compiled-in I/O.</p><p>
218
219</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCleanupOutputCallbacks"></a>xmlCleanupOutputCallbacks ()</h3><pre class="programlisting">void xmlCleanupOutputCallbacks (void);</pre><p>
220clears the entire output callback table. this includes the
221compiled-in I/O callbacks.</p><p>
222
223</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegisterDefaultInputCallbacks"></a>xmlRegisterDefaultInputCallbacks ()</h3><pre class="programlisting">void xmlRegisterDefaultInputCallbacks
224 (void);</pre><p>
225Registers the default compiled-in I/O handlers.</p><p>
226
227</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlAllocParserInputBuffer"></a>xmlAllocParserInputBuffer ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> xmlAllocParserInputBuffer
228 (<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
229Create a buffered parser input for progressive parsing</p><p>
230
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000231</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>enc</tt></i> :</span></td><td> the charset encoding if known
Daniel Veillardd7cec922003-06-13 12:30:10 +0000232</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser input or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000233</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBufferCreateFilename"></a>xmlParserInputBufferCreateFilename ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> xmlParserInputBufferCreateFilename
234 (const char *URI,
235 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
236Create a buffered parser input for the progressive parsing of a file
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000237If filename is "-' then we use stdin as the input.
Daniel Veillardd4330462003-04-29 12:40:16 +0000238Automatic support for ZLIB/Compress compressed document is provided
239by default if found at compile-time.
240Do an encoding check if enc == XML_CHAR_ENCODING_NONE</p><p>
241
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000242</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>URI</tt></i> :</span></td><td> a C string containing the URI or filename
243</td></tr><tr><td><span class="term"><i><tt>enc</tt></i> :</span></td><td> the charset encoding if known
Daniel Veillardd7cec922003-06-13 12:30:10 +0000244</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser input or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000245</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBufferCreateFile"></a>xmlParserInputBufferCreateFile ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> xmlParserInputBufferCreateFile
246 (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *file,
247 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
248Create a buffered parser input for the progressive parsing of a FILE *
249buffered C I/O</p><p>
250
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000251</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>file</tt></i> :</span></td><td> a FILE*
252</td></tr><tr><td><span class="term"><i><tt>enc</tt></i> :</span></td><td> the charset encoding if known
Daniel Veillardd7cec922003-06-13 12:30:10 +0000253</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser input or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000254</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBufferCreateFd"></a>xmlParserInputBufferCreateFd ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> xmlParserInputBufferCreateFd
255 (int fd,
256 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
257Create a buffered parser input for the progressive parsing for the input
258from a file descriptor</p><p>
259
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000260</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>fd</tt></i> :</span></td><td> a file descriptor number
261</td></tr><tr><td><span class="term"><i><tt>enc</tt></i> :</span></td><td> the charset encoding if known
Daniel Veillardd7cec922003-06-13 12:30:10 +0000262</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser input or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000263</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBufferCreateMem"></a>xmlParserInputBufferCreateMem ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> xmlParserInputBufferCreateMem
264 (const char *mem,
265 int size,
266 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
267Create a buffered parser input for the progressive parsing for the input
268from a memory area.</p><p>
269
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000270</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>mem</tt></i> :</span></td><td> the memory input
271</td></tr><tr><td><span class="term"><i><tt>size</tt></i> :</span></td><td> the length of the memory block
272</td></tr><tr><td><span class="term"><i><tt>enc</tt></i> :</span></td><td> the charset encoding if known
Daniel Veillardd7cec922003-06-13 12:30:10 +0000273</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser input or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000274</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBufferCreateIO"></a>xmlParserInputBufferCreateIO ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> xmlParserInputBufferCreateIO
275 (<a href="libxml-xmlIO.html#xmlInputReadCallback">xmlInputReadCallback</a> ioread,
276 <a href="libxml-xmlIO.html#xmlInputCloseCallback">xmlInputCloseCallback</a> ioclose,
277 void *ioctx,
278 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
279Create a buffered parser input for the progressive parsing for the input
280from an I/O handler</p><p>
281
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000282</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ioread</tt></i> :</span></td><td> an I/O read function
283</td></tr><tr><td><span class="term"><i><tt>ioclose</tt></i> :</span></td><td> an I/O close function
284</td></tr><tr><td><span class="term"><i><tt>ioctx</tt></i> :</span></td><td> an I/O handler
285</td></tr><tr><td><span class="term"><i><tt>enc</tt></i> :</span></td><td> the charset encoding if known
Daniel Veillardd7cec922003-06-13 12:30:10 +0000286</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser input or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000287</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBufferRead"></a>xmlParserInputBufferRead ()</h3><pre class="programlisting">int xmlParserInputBufferRead (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> in,
288 int len);</pre><p>
289Refresh the content of the input buffer, the old data are considered
290consumed
291This routine handle the I18N transcoding to internal UTF-8</p><p>
292
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000293</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>in</tt></i> :</span></td><td> a buffered parser input
294</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> indicative value of the amount of chars to read
Daniel Veillardd7cec922003-06-13 12:30:10 +0000295</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of chars read and stored in the buffer, or -1
296 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000297</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBufferGrow"></a>xmlParserInputBufferGrow ()</h3><pre class="programlisting">int xmlParserInputBufferGrow (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> in,
298 int len);</pre><p>
299Grow up the content of the input buffer, the old data are preserved
300This routine handle the I18N transcoding to internal UTF-8
301This routine is used when operating the parser in normal (pull) mode
302</p><p>
303TODO: one should be able to remove one extra copy by copying directly
304 onto in-&gt;buffer or in-&gt;raw</p><p>
305
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000306</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>in</tt></i> :</span></td><td> a buffered parser input
307</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> indicative value of the amount of chars to read
Daniel Veillardd7cec922003-06-13 12:30:10 +0000308</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of chars read and stored in the buffer, or -1
309 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000310</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputBufferPush"></a>xmlParserInputBufferPush ()</h3><pre class="programlisting">int xmlParserInputBufferPush (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> in,
311 int len,
312 const char *buf);</pre><p>
313Push the content of the arry in the input buffer
314This routine handle the I18N transcoding to internal UTF-8
315This is used when operating the parser in progressive (push) mode.</p><p>
316
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000317</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>in</tt></i> :</span></td><td> a buffered parser input
318</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> the size in bytes of the array.
319</td></tr><tr><td><span class="term"><i><tt>buf</tt></i> :</span></td><td> an char array
Daniel Veillardd7cec922003-06-13 12:30:10 +0000320</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of chars read and stored in the buffer, or -1
321 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000322</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFreeParserInputBuffer"></a>xmlFreeParserInputBuffer ()</h3><pre class="programlisting">void xmlFreeParserInputBuffer (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> in);</pre><p>
323Free up the memory used by a buffered parser input</p><p>
324
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000325</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>in</tt></i> :</span></td><td> a buffered parser input
Daniel Veillardd4330462003-04-29 12:40:16 +0000326</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserGetDirectory"></a>xmlParserGetDirectory ()</h3><pre class="programlisting">char* xmlParserGetDirectory (const char *filename);</pre><p>
327lookup the directory for that file</p><p>
328
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000329</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 path to a file
Daniel Veillardd7cec922003-06-13 12:30:10 +0000330</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new allocated string containing the directory, or NULL.
Daniel Veillardd4330462003-04-29 12:40:16 +0000331</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegisterInputCallbacks"></a>xmlRegisterInputCallbacks ()</h3><pre class="programlisting">int xmlRegisterInputCallbacks (<a href="libxml-xmlIO.html#xmlInputMatchCallback">xmlInputMatchCallback</a> matchFunc,
332 <a href="libxml-xmlIO.html#xmlInputOpenCallback">xmlInputOpenCallback</a> openFunc,
333 <a href="libxml-xmlIO.html#xmlInputReadCallback">xmlInputReadCallback</a> readFunc,
334 <a href="libxml-xmlIO.html#xmlInputCloseCallback">xmlInputCloseCallback</a> closeFunc);</pre><p>
335Register a new set of I/O callback for handling parser input.</p><p>
336
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000337</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>matchFunc</tt></i> :</span></td><td> the xmlInputMatchCallback
338</td></tr><tr><td><span class="term"><i><tt>openFunc</tt></i> :</span></td><td> the xmlInputOpenCallback
339</td></tr><tr><td><span class="term"><i><tt>readFunc</tt></i> :</span></td><td> the xmlInputReadCallback
340</td></tr><tr><td><span class="term"><i><tt>closeFunc</tt></i> :</span></td><td> the xmlInputCloseCallback
Daniel Veillardd7cec922003-06-13 12:30:10 +0000341</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the registered handler number or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000342</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegisterDefaultOutputCallbacks"></a>xmlRegisterDefaultOutputCallbacks ()</h3><pre class="programlisting">void xmlRegisterDefaultOutputCallbacks
343 (void);</pre><p>
344Registers the default compiled-in I/O handlers.</p><p>
345
346</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlAllocOutputBuffer"></a>xmlAllocOutputBuffer ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> xmlAllocOutputBuffer (<a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder);</pre><p>
347Create a buffered parser output</p><p>
348
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000349</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>encoder</tt></i> :</span></td><td> the encoding converter or NULL
Daniel Veillardd7cec922003-06-13 12:30:10 +0000350</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser output or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000351</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBufferCreateFilename"></a>xmlOutputBufferCreateFilename ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> xmlOutputBufferCreateFilename
352 (const char *URI,
353 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder,
354 int compression);</pre><p>
355Create a buffered output for the progressive saving of a file
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000356If filename is "-' then we use stdout as the output.
Daniel Veillardd4330462003-04-29 12:40:16 +0000357Automatic support for ZLIB/Compress compressed document is provided
358by default if found at compile-time.
359TODO: currently if compression is set, the library only support
360 writing to a local file.</p><p>
361
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000362</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>URI</tt></i> :</span></td><td> a C string containing the URI or filename
363</td></tr><tr><td><span class="term"><i><tt>encoder</tt></i> :</span></td><td> the encoding converter or NULL
364</td></tr><tr><td><span class="term"><i><tt>compression</tt></i> :</span></td><td> the compression ration (0 none, 9 max).
Daniel Veillardd7cec922003-06-13 12:30:10 +0000365</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new output or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000366</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBufferCreateFile"></a>xmlOutputBufferCreateFile ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> xmlOutputBufferCreateFile
367 (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *file,
368 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder);</pre><p>
369Create a buffered output for the progressive saving to a FILE *
370buffered C I/O</p><p>
371
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000372</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>file</tt></i> :</span></td><td> a FILE*
373</td></tr><tr><td><span class="term"><i><tt>encoder</tt></i> :</span></td><td> the encoding converter or NULL
Daniel Veillardd7cec922003-06-13 12:30:10 +0000374</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser output or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000375</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBufferCreateFd"></a>xmlOutputBufferCreateFd ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> xmlOutputBufferCreateFd (int fd,
376 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder);</pre><p>
377Create a buffered output for the progressive saving
378to a file descriptor</p><p>
379
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000380</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>fd</tt></i> :</span></td><td> a file descriptor number
381</td></tr><tr><td><span class="term"><i><tt>encoder</tt></i> :</span></td><td> the encoding converter or NULL
Daniel Veillardd7cec922003-06-13 12:30:10 +0000382</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser output or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000383</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBufferCreateIO"></a>xmlOutputBufferCreateIO ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> xmlOutputBufferCreateIO (<a href="libxml-xmlIO.html#xmlOutputWriteCallback">xmlOutputWriteCallback</a> iowrite,
384 <a href="libxml-xmlIO.html#xmlOutputCloseCallback">xmlOutputCloseCallback</a> ioclose,
385 void *ioctx,
386 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> encoder);</pre><p>
387Create a buffered output for the progressive saving
388to an I/O handler</p><p>
389
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000390</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>iowrite</tt></i> :</span></td><td> an I/O write function
391</td></tr><tr><td><span class="term"><i><tt>ioclose</tt></i> :</span></td><td> an I/O close function
392</td></tr><tr><td><span class="term"><i><tt>ioctx</tt></i> :</span></td><td> an I/O handler
393</td></tr><tr><td><span class="term"><i><tt>encoder</tt></i> :</span></td><td> the charset encoding if known
Daniel Veillardd7cec922003-06-13 12:30:10 +0000394</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser output or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000395</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBufferWrite"></a>xmlOutputBufferWrite ()</h3><pre class="programlisting">int xmlOutputBufferWrite (<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> out,
396 int len,
397 const char *buf);</pre><p>
398Write the content of the array in the output I/O buffer
399This routine handle the I18N transcoding from internal UTF-8
400The buffer is lossless, i.e. will store in case of partial
401or delayed writes.</p><p>
402
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000403</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 buffered parser output
404</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> the size in bytes of the array.
405</td></tr><tr><td><span class="term"><i><tt>buf</tt></i> :</span></td><td> an char array
Daniel Veillardd7cec922003-06-13 12:30:10 +0000406</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of chars immediately written, or -1
407 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000408</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBufferWriteString"></a>xmlOutputBufferWriteString ()</h3><pre class="programlisting">int xmlOutputBufferWriteString (<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> out,
409 const char *str);</pre><p>
410Write the content of the string in the output I/O buffer
411This routine handle the I18N transcoding from internal UTF-8
412The buffer is lossless, i.e. will store in case of partial
413or delayed writes.</p><p>
414
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000415</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 buffered parser output
416</td></tr><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td> a zero terminated C string
Daniel Veillardd7cec922003-06-13 12:30:10 +0000417</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of chars immediately written, or -1
418 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000419</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBufferFlush"></a>xmlOutputBufferFlush ()</h3><pre class="programlisting">int xmlOutputBufferFlush (<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> out);</pre><p>
420flushes the output I/O channel</p><p>
421
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000422</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 buffered output
Daniel Veillardd7cec922003-06-13 12:30:10 +0000423</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of byte written or -1 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000424</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlOutputBufferClose"></a>xmlOutputBufferClose ()</h3><pre class="programlisting">int xmlOutputBufferClose (<a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> out);</pre><p>
425flushes and close the output I/O channel
426and free up all the associated resources</p><p>
427
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000428</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 buffered output
Daniel Veillardd7cec922003-06-13 12:30:10 +0000429</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of byte written or -1 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000430</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegisterOutputCallbacks"></a>xmlRegisterOutputCallbacks ()</h3><pre class="programlisting">int xmlRegisterOutputCallbacks (<a href="libxml-xmlIO.html#xmlOutputMatchCallback">xmlOutputMatchCallback</a> matchFunc,
431 <a href="libxml-xmlIO.html#xmlOutputOpenCallback">xmlOutputOpenCallback</a> openFunc,
432 <a href="libxml-xmlIO.html#xmlOutputWriteCallback">xmlOutputWriteCallback</a> writeFunc,
433 <a href="libxml-xmlIO.html#xmlOutputCloseCallback">xmlOutputCloseCallback</a> closeFunc);</pre><p>
434Register a new set of I/O callback for handling output.</p><p>
435
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000436</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>matchFunc</tt></i> :</span></td><td> the xmlOutputMatchCallback
437</td></tr><tr><td><span class="term"><i><tt>openFunc</tt></i> :</span></td><td> the xmlOutputOpenCallback
438</td></tr><tr><td><span class="term"><i><tt>writeFunc</tt></i> :</span></td><td> the xmlOutputWriteCallback
439</td></tr><tr><td><span class="term"><i><tt>closeFunc</tt></i> :</span></td><td> the xmlOutputCloseCallback
Daniel Veillardd7cec922003-06-13 12:30:10 +0000440</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the registered handler number or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000441</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOHTTPOpenW"></a>xmlIOHTTPOpenW ()</h3><pre class="programlisting">void* xmlIOHTTPOpenW (const char *post_uri,
442 int compression);</pre><p>
443Open a temporary buffer to collect the document for a subsequent HTTP POST
444request. Non-static as is called from the output buffer creation routine.</p><p>
445
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000446</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>post_uri</tt></i> :</span></td><td> The destination URI for the document
447</td></tr><tr><td><span class="term"><i><tt>compression</tt></i> :</span></td><td> The compression desired for the document.
Daniel Veillardd4330462003-04-29 12:40:16 +0000448</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlRegisterHTTPPostCallbacks"></a>xmlRegisterHTTPPostCallbacks ()</h3><pre class="programlisting">void xmlRegisterHTTPPostCallbacks (void);</pre><p>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000449By default, libxml submits HTTP output requests using the "PUT" method.
450Calling this method changes the HTTP output method to use the "POST"
Daniel Veillardd4330462003-04-29 12:40:16 +0000451method instead.</p><p>
452
453</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNoNetExternalEntityLoader"></a>xmlNoNetExternalEntityLoader ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> xmlNoNetExternalEntityLoader
454 (const char *URL,
455 const char *ID,
456 <a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
457A specific entity loader disabling network accesses, though still
458allowing local catalog accesses for resolution.</p><p>
459
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000460</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>URL</tt></i> :</span></td><td> the URL for the entity to load
461</td></tr><tr><td><span class="term"><i><tt>ID</tt></i> :</span></td><td> the System ID for the entity to load
462</td></tr><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the context in which the entity is called or NULL
Daniel Veillardd7cec922003-06-13 12:30:10 +0000463</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new allocated xmlParserInputPtr, or NULL.
Daniel Veillardd4330462003-04-29 12:40:16 +0000464</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNormalizeWindowsPath"></a>xmlNormalizeWindowsPath ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlNormalizeWindowsPath (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *path);</pre><p>
465This function is obsolete. Please see xmlURIFromPath in uri.c for
466a better solution.</p><p>
467
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000468</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>path</tt></i> :</span></td><td> the input file path
Daniel Veillardd7cec922003-06-13 12:30:10 +0000469</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a canonicalized version of the path
Daniel Veillardd4330462003-04-29 12:40:16 +0000470</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCheckFilename"></a>xmlCheckFilename ()</h3><pre class="programlisting">int xmlCheckFilename (const char *path);</pre><p>
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000471function checks to see if <i><tt>path</tt></i> is a valid source
Daniel Veillardd4330462003-04-29 12:40:16 +0000472(file, socket...) for XML.
473</p><p>
474if stat is not available on the target machine,
475returns 1. if stat fails, returns 0 (if calling
476stat on the filename fails, it can't be right).
477if stat succeeds and the file is a directory,</p><p>
478
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000479</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>path</tt></i> :</span></td><td> the path to check
Daniel Veillardd7cec922003-06-13 12:30:10 +0000480</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>2. otherwise returns 1.
Daniel Veillardd4330462003-04-29 12:40:16 +0000481</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFileMatch"></a>xmlFileMatch ()</h3><pre class="programlisting">int xmlFileMatch (const char *filename);</pre><p>
482input from FILE *</p><p>
483
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000484</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 URI for matching
Daniel Veillardd7cec922003-06-13 12:30:10 +0000485</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if matches, 0 otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000486</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFileOpen"></a>xmlFileOpen ()</h3><pre class="programlisting">void* xmlFileOpen (const char *filename);</pre><p>
487Wrapper around xmlFileOpen_real that try it with an unescaped
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000488version of <i><tt>filename</tt></i>, if this fails fallback to <i><tt>filename</tt></i></p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000489
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000490</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 URI for matching
Daniel Veillardd4330462003-04-29 12:40:16 +0000491</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFileRead"></a>xmlFileRead ()</h3><pre class="programlisting">int xmlFileRead (void *context,
492 char *buffer,
493 int len);</pre><p>
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000494Read <i><tt>len</tt></i> bytes to <i><tt>buffer</tt></i> from the I/O channel.</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000495
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000496</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> the I/O context
497</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td> where to drop data
498</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> number of bytes to write
Daniel Veillardd7cec922003-06-13 12:30:10 +0000499</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of bytes written
Daniel Veillardd4330462003-04-29 12:40:16 +0000500</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFileClose"></a>xmlFileClose ()</h3><pre class="programlisting">int xmlFileClose (void *context);</pre><p>
501Close an I/O channel</p><p>
502
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000503</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> the I/O context
Daniel Veillardd7cec922003-06-13 12:30:10 +0000504</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000505</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOHTTPMatch"></a>xmlIOHTTPMatch ()</h3><pre class="programlisting">int xmlIOHTTPMatch (const char *filename);</pre><p>
506check if the URI matches an HTTP one</p><p>
507
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000508</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 URI for matching
Daniel Veillardd7cec922003-06-13 12:30:10 +0000509</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if matches, 0 otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000510</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOHTTPOpen"></a>xmlIOHTTPOpen ()</h3><pre class="programlisting">void* xmlIOHTTPOpen (const char *filename);</pre><p>
511open an HTTP I/O channel</p><p>
512
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000513</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 URI for matching
Daniel Veillardd4330462003-04-29 12:40:16 +0000514</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOHTTPRead"></a>xmlIOHTTPRead ()</h3><pre class="programlisting">int xmlIOHTTPRead (void *context,
515 char *buffer,
516 int len);</pre><p>
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000517Read <i><tt>len</tt></i> bytes to <i><tt>buffer</tt></i> from the I/O channel.</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000518
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000519</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> the I/O context
520</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td> where to drop data
521</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> number of bytes to write
Daniel Veillardd7cec922003-06-13 12:30:10 +0000522</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of bytes written
Daniel Veillardd4330462003-04-29 12:40:16 +0000523</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOHTTPClose"></a>xmlIOHTTPClose ()</h3><pre class="programlisting">int xmlIOHTTPClose (void *context);</pre><p>
524Close an HTTP I/O channel</p><p>
525
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000526</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> the I/O context
Daniel Veillardd7cec922003-06-13 12:30:10 +0000527</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0
Daniel Veillardd4330462003-04-29 12:40:16 +0000528</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOFTPMatch"></a>xmlIOFTPMatch ()</h3><pre class="programlisting">int xmlIOFTPMatch (const char *filename);</pre><p>
529check if the URI matches an FTP one</p><p>
530
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000531</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 URI for matching
Daniel Veillardd7cec922003-06-13 12:30:10 +0000532</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if matches, 0 otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000533</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOFTPOpen"></a>xmlIOFTPOpen ()</h3><pre class="programlisting">void* xmlIOFTPOpen (const char *filename);</pre><p>
534open an FTP I/O channel</p><p>
535
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000536</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 URI for matching
Daniel Veillardd4330462003-04-29 12:40:16 +0000537</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOFTPRead"></a>xmlIOFTPRead ()</h3><pre class="programlisting">int xmlIOFTPRead (void *context,
538 char *buffer,
539 int len);</pre><p>
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000540Read <i><tt>len</tt></i> bytes to <i><tt>buffer</tt></i> from the I/O channel.</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000541
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000542</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> the I/O context
543</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td> where to drop data
544</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> number of bytes to write
Daniel Veillardd7cec922003-06-13 12:30:10 +0000545</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of bytes written
Daniel Veillardd4330462003-04-29 12:40:16 +0000546</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIOFTPClose"></a>xmlIOFTPClose ()</h3><pre class="programlisting">int xmlIOFTPClose (void *context);</pre><p>
547Close an FTP I/O channel</p><p>
548
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000549</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>context</tt></i> :</span></td><td> the I/O context
Daniel Veillardd7cec922003-06-13 12:30:10 +0000550</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000551</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-nanoftp.html"><b>&lt;&lt; nanoftp</b></a></td><td align="right"><a accesskey="n" href="libxml-catalog.html"><b>catalog &gt;&gt;</b></a></td></tr></table></body></html>