Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / libxml2 / 272693c7e127a43dbcd5bc39c1cec4bfcdabcd2a / . / doc / html / libxml-xmlreader.html
blob: a177b34986f3ef9b5e9e923cb49b0af68419b42d [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>xmlreader</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-parser.html" title="parser"><link rel="next" href="libxml-SAX.html" title="SAX"></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-parser.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-SAX.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-xmlreader"></a><div class="titlepage"></div><div class="refnamediv"><h2>xmlreader</h2><p>xmlreader &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]32
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]33
34
35enum <a href="libxml-xmlreader.html#xmlParserProperties">xmlParserProperties</a>;
36enum <a href="libxml-xmlreader.html#xmlParserSeverities">xmlParserSeverities</a>;
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]37enum <a href="libxml-xmlreader.html#xmlReaderTypes">xmlReaderTypes</a>;
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]38struct <a href="libxml-xmlreader.html#xmlTextReader">xmlTextReader</a>;
39typedef <a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a>;
40<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> <a href="libxml-xmlreader.html#xmlNewTextReader">xmlNewTextReader</a> (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> input,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]41 const char *URI);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]42<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> <a href="libxml-xmlreader.html#xmlNewTextReaderFilename">xmlNewTextReaderFilename</a> (const char *URI);
43void <a href="libxml-xmlreader.html#xmlFreeTextReader">xmlFreeTextReader</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
44int <a href="libxml-xmlreader.html#xmlTextReaderRead">xmlTextReaderRead</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
45<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderReadInnerXml">xmlTextReaderReadInnerXml</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
46<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderReadOuterXml">xmlTextReaderReadOuterXml</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
47<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderReadString">xmlTextReaderReadString</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
48int <a href="libxml-xmlreader.html#xmlTextReaderReadAttributeValue">xmlTextReaderReadAttributeValue</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
49int <a href="libxml-xmlreader.html#xmlTextReaderAttributeCount">xmlTextReaderAttributeCount</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
50<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderBaseUri">xmlTextReaderBaseUri</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
51int <a href="libxml-xmlreader.html#xmlTextReaderDepth">xmlTextReaderDepth</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
52int <a href="libxml-xmlreader.html#xmlTextReaderHasAttributes">xmlTextReaderHasAttributes</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
53int <a href="libxml-xmlreader.html#xmlTextReaderHasValue">xmlTextReaderHasValue</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
54int <a href="libxml-xmlreader.html#xmlTextReaderIsDefault">xmlTextReaderIsDefault</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
55int <a href="libxml-xmlreader.html#xmlTextReaderIsEmptyElement">xmlTextReaderIsEmptyElement</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
56<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderLocalName">xmlTextReaderLocalName</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
57<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderName">xmlTextReaderName</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
58<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderNamespaceUri">xmlTextReaderNamespaceUri</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
59int <a href="libxml-xmlreader.html#xmlTextReaderNodeType">xmlTextReaderNodeType</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
60<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderPrefix">xmlTextReaderPrefix</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
61int <a href="libxml-xmlreader.html#xmlTextReaderQuoteChar">xmlTextReaderQuoteChar</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
62<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderValue">xmlTextReaderValue</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
63<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderXmlLang">xmlTextReaderXmlLang</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
64int <a href="libxml-xmlreader.html#xmlTextReaderReadState">xmlTextReaderReadState</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
65int <a href="libxml-xmlreader.html#xmlTextReaderClose">xmlTextReaderClose</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
66<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderGetAttributeNo">xmlTextReaderGetAttributeNo</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]67 int no);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]68<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderGetAttribute">xmlTextReaderGetAttribute</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
69 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);
70<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderGetAttributeNs">xmlTextReaderGetAttributeNs</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
71 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *localName,
72 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *namespaceURI);
73<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> <a href="libxml-xmlreader.html#xmlTextReaderGetRemainder">xmlTextReaderGetRemainder</a>
74 (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
75<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderLookupNamespace">xmlTextReaderLookupNamespace</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
76 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *prefix);
77int <a href="libxml-xmlreader.html#xmlTextReaderMoveToAttributeNo">xmlTextReaderMoveToAttributeNo</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]78 int no);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]79int <a href="libxml-xmlreader.html#xmlTextReaderMoveToAttribute">xmlTextReaderMoveToAttribute</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
80 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);
81int <a href="libxml-xmlreader.html#xmlTextReaderMoveToAttributeNs">xmlTextReaderMoveToAttributeNs</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
82 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *localName,
83 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *namespaceURI);
84int <a href="libxml-xmlreader.html#xmlTextReaderMoveToFirstAttribute">xmlTextReaderMoveToFirstAttribute</a>
85 (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
86int <a href="libxml-xmlreader.html#xmlTextReaderMoveToNextAttribute">xmlTextReaderMoveToNextAttribute</a>
87 (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
88int <a href="libxml-xmlreader.html#xmlTextReaderMoveToElement">xmlTextReaderMoveToElement</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
89int <a href="libxml-xmlreader.html#xmlTextReaderNormalization">xmlTextReaderNormalization</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
90int <a href="libxml-xmlreader.html#xmlTextReaderSetParserProp">xmlTextReaderSetParserProp</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]91 int prop,
92 int value);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]93int <a href="libxml-xmlreader.html#xmlTextReaderGetParserProp">xmlTextReaderGetParserProp</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]94 int prop);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]95<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> <a href="libxml-xmlreader.html#xmlTextReaderCurrentNode">xmlTextReaderCurrentNode</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
96<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> <a href="libxml-xmlreader.html#xmlTextReaderCurrentDoc">xmlTextReaderCurrentDoc</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
97<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> <a href="libxml-xmlreader.html#xmlTextReaderExpand">xmlTextReaderExpand</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
98int <a href="libxml-xmlreader.html#xmlTextReaderNext">xmlTextReaderNext</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
99int <a href="libxml-xmlreader.html#xmlTextReaderIsValid">xmlTextReaderIsValid</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
100int <a href="libxml-xmlreader.html#xmlTextReaderRelaxNGValidate">xmlTextReaderRelaxNGValidate</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
101 const char *rng);
102int <a href="libxml-xmlreader.html#xmlTextReaderRelaxNGSetSchema">xmlTextReaderRelaxNGSetSchema</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
103 <a href="libxml-relaxng.html#xmlRelaxNGPtr">xmlRelaxNGPtr</a> schema);
104typedef <a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a>;
105void (<a href="libxml-xmlreader.html#xmlTextReaderErrorFunc">*xmlTextReaderErrorFunc</a>) (void *arg,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]106 const char *msg,
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]107 <a href="libxml-xmlreader.html#xmlParserSeverities">xmlParserSeverities</a> severity,
108 <a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a> locator);
109int <a href="libxml-xmlreader.html#xmlTextReaderLocatorLineNumber">xmlTextReaderLocatorLineNumber</a> (<a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a> locator);
110<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-xmlreader.html#xmlTextReaderLocatorBaseURI">xmlTextReaderLocatorBaseURI</a> (<a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a> locator);
111void <a href="libxml-xmlreader.html#xmlTextReaderSetErrorHandler">xmlTextReaderSetErrorHandler</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
112 <a href="libxml-xmlreader.html#xmlTextReaderErrorFunc">xmlTextReaderErrorFunc</a> f,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]113 void *arg);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]114void <a href="libxml-xmlreader.html#xmlTextReaderGetErrorHandler">xmlTextReaderGetErrorHandler</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
115 <a href="libxml-xmlreader.html#xmlTextReaderErrorFunc">xmlTextReaderErrorFunc</a> *f,
116 void **arg);
117</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
118
119</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="xmlParserProperties"></a>enum xmlParserProperties</h3><pre class="programlisting">typedef enum {
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]120 XML_PARSER_LOADDTD = 1,
121 XML_PARSER_DEFAULTATTRS = 2,
122 XML_PARSER_VALIDATE = 3,
123 XML_PARSER_SUBST_ENTITIES = 4
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]124} xmlParserProperties;
125</pre><p>
126
127</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserSeverities"></a>enum xmlParserSeverities</h3><pre class="programlisting">typedef enum {
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]128 XML_PARSER_SEVERITY_VALIDITY_WARNING = 1,
129 XML_PARSER_SEVERITY_VALIDITY_ERROR = 2,
130 XML_PARSER_SEVERITY_WARNING = 3,
131 XML_PARSER_SEVERITY_ERROR = 4
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]132} xmlParserSeverities;
133</pre><p>
134
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]135</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlReaderTypes"></a>enum xmlReaderTypes</h3><pre class="programlisting">typedef enum {
136 XML_READER_TYPE_NONE = 0,
137 XML_READER_TYPE_ELEMENT = 1,
138 XML_READER_TYPE_ATTRIBUTE = 2,
139 XML_READER_TYPE_TEXT = 3,
140 XML_READER_TYPE_CDATA = 4,
141 XML_READER_TYPE_ENTITY_REFERENCE = 5,
142 XML_READER_TYPE_ENTITY = 6,
143 XML_READER_TYPE_PROCESSING_INSTRUCTION = 7,
144 XML_READER_TYPE_COMMENT = 8,
145 XML_READER_TYPE_DOCUMENT = 9,
146 XML_READER_TYPE_DOCUMENT_TYPE = 10,
147 XML_READER_TYPE_DOCUMENT_FRAGMENT = 11,
148 XML_READER_TYPE_NOTATION = 12,
149 XML_READER_TYPE_WHITESPACE = 13,
150 XML_READER_TYPE_SIGNIFICANT_WHITESPACE = 14,
151 XML_READER_TYPE_END_ELEMENT = 15,
152 XML_READER_TYPE_END_ENTITY = 16,
153 XML_READER_TYPE_XML_DECLARATION = 17
154} xmlReaderTypes;
155</pre><p>
156
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]157</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReader"></a>struct xmlTextReader</h3><pre class="programlisting">struct xmlTextReader;</pre><p>
158
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]159</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderPtr"></a>xmlTextReaderPtr</h3><pre class="programlisting">typedef xmlTextReader *xmlTextReaderPtr;
160</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]161
162</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewTextReader"></a>xmlNewTextReader ()</h3><pre class="programlisting"><a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> xmlNewTextReader (<a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> input,
163 const char *URI);</pre><p>
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]164Create an xmlTextReader structure fed with <i><tt>input</tt></i></p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]165
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]166</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>input</tt></i> :</span></td><td> the xmlParserInputBufferPtr used to read data
167</td></tr><tr><td><span class="term"><i><tt>URI</tt></i> :</span></td><td> the URI information for the source if available
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]168</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new xmlTextReaderPtr or NULL in case of error
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="xmlNewTextReaderFilename"></a>xmlNewTextReaderFilename ()</h3><pre class="programlisting"><a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> xmlNewTextReaderFilename (const char *URI);</pre><p>
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]170Create an xmlTextReader structure fed with the resource at <i><tt>URI</tt></i></p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]171
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]172</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> the URI of the resource to process
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]173</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new xmlTextReaderPtr or NULL in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]174</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFreeTextReader"></a>xmlFreeTextReader ()</h3><pre class="programlisting">void xmlFreeTextReader (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
175Deallocate all the resources associated to the reader</p><p>
176
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]177</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]178</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderRead"></a>xmlTextReaderRead ()</h3><pre class="programlisting">int xmlTextReaderRead (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
179Moves the position of the current instance to the next node in
180 the stream, exposing its properties.</p><p>
181
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]182</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]183</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if the node was read successfully, 0 if there is no more
184 nodes to read, or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]185</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderReadInnerXml"></a>xmlTextReaderReadInnerXml ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderReadInnerXml (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
186Reads the contents of the current node, including child nodes and markup.</p><p>
187
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]188</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]189</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a string containing the XML content, or NULL if the current node
190 is neither an element nor attribute, or has no child nodes. The
191 string must be deallocated by the caller.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]192</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderReadOuterXml"></a>xmlTextReaderReadOuterXml ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderReadOuterXml (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
193Reads the contents of the current node, including child nodes and markup.</p><p>
194
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]195</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]196</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a string containing the XML content, or NULL if the current node
197 is neither an element nor attribute, or has no child nodes. The
198 string must be deallocated by the caller.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]199</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderReadString"></a>xmlTextReaderReadString ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderReadString (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
200Reads the contents of an element or a text node as a string.</p><p>
201
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]202</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]203</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a string containing the contents of the Element or Text node,
204 or NULL if the reader is positioned on any other type of node.
205 The string must be deallocated by the caller.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]206</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderReadAttributeValue"></a>xmlTextReaderReadAttributeValue ()</h3><pre class="programlisting">int xmlTextReaderReadAttributeValue (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
207Parses an attribute value into one or more Text and EntityReference nodes.</p><p>
208
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]209</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]210</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 in case of success, 0 if the reader was not positionned on an
211 ttribute node or all the attribute values have been read, or -1
212 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]213</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderAttributeCount"></a>xmlTextReaderAttributeCount ()</h3><pre class="programlisting">int xmlTextReaderAttributeCount (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
214Provides the number of attributes of the current node</p><p>
215
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]216</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]217</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 i no attributes, -1 in case of error or the attribute count
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]218</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderBaseUri"></a>xmlTextReaderBaseUri ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderBaseUri (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
219The base URI of the node.</p><p>
220
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]221</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]222</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the base URI or NULL if not available
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]223</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderDepth"></a>xmlTextReaderDepth ()</h3><pre class="programlisting">int xmlTextReaderDepth (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
224The depth of the node in the tree.</p><p>
225
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]226</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]227</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the depth or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]228</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderHasAttributes"></a>xmlTextReaderHasAttributes ()</h3><pre class="programlisting">int xmlTextReaderHasAttributes (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
229Whether the node has attributes.</p><p>
230
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]231</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]232</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true, 0 if false, and -1 in case or error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]233</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderHasValue"></a>xmlTextReaderHasValue ()</h3><pre class="programlisting">int xmlTextReaderHasValue (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
234Whether the node can have a text value.</p><p>
235
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]236</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]237</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true, 0 if false, and -1 in case or error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]238</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderIsDefault"></a>xmlTextReaderIsDefault ()</h3><pre class="programlisting">int xmlTextReaderIsDefault (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
239Whether an Attribute node was generated from the default value
240defined in the DTD or schema.</p><p>
241
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]242</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]243</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not defaulted, 1 if defaulted, and -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]244</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderIsEmptyElement"></a>xmlTextReaderIsEmptyElement ()</h3><pre class="programlisting">int xmlTextReaderIsEmptyElement (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
245Check if the current node is empty</p><p>
246
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]247</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]248</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if empty, 0 if not and -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]249</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderLocalName"></a>xmlTextReaderLocalName ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderLocalName (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
250The local name of the node.</p><p>
251
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]252</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]253</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the local name or NULL if not available
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]254</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderName"></a>xmlTextReaderName ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderName (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
255The qualified name of the node, equal to Prefix :LocalName.</p><p>
256
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]257</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]258</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the local name or NULL if not available
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]259</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderNamespaceUri"></a>xmlTextReaderNamespaceUri ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderNamespaceUri (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
260The URI defining the namespace associated with the node.</p><p>
261
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]262</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]263</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the namespace URI or NULL if not available
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]264</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderNodeType"></a>xmlTextReaderNodeType ()</h3><pre class="programlisting">int xmlTextReaderNodeType (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
265Get the node type of the current node
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]266Reference:
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]267http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html</p><p>
268
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]269</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]270</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlNodeType of the current node or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]271</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderPrefix"></a>xmlTextReaderPrefix ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderPrefix (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
272A shorthand reference to the namespace associated with the node.</p><p>
273
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]274</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]275</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the prefix or NULL if not available
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]276</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderQuoteChar"></a>xmlTextReaderQuoteChar ()</h3><pre class="programlisting">int xmlTextReaderQuoteChar (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
277The quotation mark character used to enclose the value of an attribute.</p><p>
278
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]279</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]280</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>" or ' and -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]281</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderValue"></a>xmlTextReaderValue ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderValue (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
282Provides the text value of the node if present</p><p>
283
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]284</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]285</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the string or NULL if not available. The retsult must be deallocated
286 with <a href="libxml-globals.html#xmlFree">xmlFree</a>()
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]287</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderXmlLang"></a>xmlTextReaderXmlLang ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderXmlLang (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
288The xml:lang scope within which the node resides.</p><p>
289
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]290</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]291</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xml:lang value or NULL if none exists.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]292</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderReadState"></a>xmlTextReaderReadState ()</h3><pre class="programlisting">int xmlTextReaderReadState (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
293Gets the read state of the reader.</p><p>
294
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]295</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]296</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the state value, or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]297</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderClose"></a>xmlTextReaderClose ()</h3><pre class="programlisting">int xmlTextReaderClose (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
298This method releases any resources allocated by the current instance
299changes the state to Closed and close any underlying input.</p><p>
300
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]301</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]302</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 +0000[diff] [blame]303</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderGetAttributeNo"></a>xmlTextReaderGetAttributeNo ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderGetAttributeNo (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
304 int no);</pre><p>
305Provides the value of the attribute with the specified index relative
306to the containing element.</p><p>
307
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]308</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
309</td></tr><tr><td><span class="term"><i><tt>no</tt></i> :</span></td><td> the zero-based index of the attribute relative to the containing element
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]310</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a string containing the value of the specified attribute, or NULL
311 in case of error. The string must be deallocated by the caller.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]312</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderGetAttribute"></a>xmlTextReaderGetAttribute ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderGetAttribute (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
313 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p>
314Provides the value of the attribute with the specified qualified name.</p><p>
315
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]316</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
317</td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the qualified name of the attribute.
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]318</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a string containing the value of the specified attribute, or NULL
319 in case of error. The string must be deallocated by the caller.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]320</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderGetAttributeNs"></a>xmlTextReaderGetAttributeNs ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderGetAttributeNs (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
321 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *localName,
322 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *namespaceURI);</pre><p>
323Provides the value of the specified attribute</p><p>
324
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]325</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
326</td></tr><tr><td><span class="term"><i><tt>localName</tt></i> :</span></td><td> the local name of the attribute.
327</td></tr><tr><td><span class="term"><i><tt>namespaceURI</tt></i> :</span></td><td> the namespace URI of the attribute.
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]328</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a string containing the value of the specified attribute, or NULL
329 in case of error. The string must be deallocated by the caller.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]330</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderGetRemainder"></a>xmlTextReaderGetRemainder ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputBufferPtr">xmlParserInputBufferPtr</a> xmlTextReaderGetRemainder
331 (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
332Method to get the remainder of the buffered XML. this method stops the
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]333parser, set its state to End Of File and return the input stream with
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]334what is left that the parser did not use.</p><p>
335
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]336</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]337</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlParserInputBufferPtr attached to the XML or NULL
338 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]339</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderLookupNamespace"></a>xmlTextReaderLookupNamespace ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderLookupNamespace (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
340 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *prefix);</pre><p>
341Resolves a namespace prefix in the scope of the current element.</p><p>
342
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]343</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
344</td></tr><tr><td><span class="term"><i><tt>prefix</tt></i> :</span></td><td> the prefix whose namespace URI is to be resolved. To return
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]345 the default namespace, specify NULL
346</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a string containing the namespace URI to which the prefix maps
347 or NULL in case of error. The string must be deallocated by the caller.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]348</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderMoveToAttributeNo"></a>xmlTextReaderMoveToAttributeNo ()</h3><pre class="programlisting">int xmlTextReaderMoveToAttributeNo (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
349 int no);</pre><p>
350Moves the position of the current instance to the attribute with
351the specified index relative to the containing element.</p><p>
352
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]353</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
354</td></tr><tr><td><span class="term"><i><tt>no</tt></i> :</span></td><td> the zero-based index of the attribute relative to the containing
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]355 element.
356</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 in case of success, -1 in case of error, 0 if not found
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]357</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderMoveToAttribute"></a>xmlTextReaderMoveToAttribute ()</h3><pre class="programlisting">int xmlTextReaderMoveToAttribute (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
358 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p>
359Moves the position of the current instance to the attribute with
360the specified qualified name.</p><p>
361
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]362</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
363</td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the qualified name of the attribute.
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]364</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 in case of success, -1 in case of error, 0 if not found
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]365</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderMoveToAttributeNs"></a>xmlTextReaderMoveToAttributeNs ()</h3><pre class="programlisting">int xmlTextReaderMoveToAttributeNs (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
366 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *localName,
367 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *namespaceURI);</pre><p>
368Moves the position of the current instance to the attribute with the
369specified local name and namespace URI.</p><p>
370
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]371</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
372</td></tr><tr><td><span class="term"><i><tt>localName</tt></i> :</span></td><td> the local name of the attribute.
373</td></tr><tr><td><span class="term"><i><tt>namespaceURI</tt></i> :</span></td><td> the namespace URI of the attribute.
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]374</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 in case of success, -1 in case of error, 0 if not found
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]375</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderMoveToFirstAttribute"></a>xmlTextReaderMoveToFirstAttribute ()</h3><pre class="programlisting">int xmlTextReaderMoveToFirstAttribute
376 (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
377Moves the position of the current instance to the first attribute
378associated with the current node.</p><p>
379
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]380</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]381</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 in case of success, -1 in case of error, 0 if not found
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]382</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderMoveToNextAttribute"></a>xmlTextReaderMoveToNextAttribute ()</h3><pre class="programlisting">int xmlTextReaderMoveToNextAttribute
383 (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
384Moves the position of the current instance to the next attribute
385associated with the current node.</p><p>
386
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]387</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]388</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 in case of success, -1 in case of error, 0 if not found
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]389</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderMoveToElement"></a>xmlTextReaderMoveToElement ()</h3><pre class="programlisting">int xmlTextReaderMoveToElement (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
390Moves the position of the current instance to the node that
391contains the current Attribute node.</p><p>
392
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]393</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]394</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 in case of success, -1 in case of error, 0 if not moved
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]395</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderNormalization"></a>xmlTextReaderNormalization ()</h3><pre class="programlisting">int xmlTextReaderNormalization (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
396The value indicating whether to normalize white space and attribute values.
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]397Since attribute value and end of line normalizations are a MUST in the XML
398specification only the value true is accepted. The broken bahaviour of
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]399accepting out of range character entities like &amp;<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="0-CAPS">0</GTKDOCLINK>; is of course not
400supported either.</p><p>
401
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]402</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]403</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 or -1 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]404</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderSetParserProp"></a>xmlTextReaderSetParserProp ()</h3><pre class="programlisting">int xmlTextReaderSetParserProp (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]405 int prop,
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]406 int value);</pre><p>
407Change the parser processing behaviour by changing some of its internal
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]408properties. Note that some properties can only be changed before any
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]409read has been done.</p><p>
410
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]411</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
412</td></tr><tr><td><span class="term"><i><tt>prop</tt></i> :</span></td><td> the xmlParserProperties to set
413</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> usually 0 or 1 to (de)activate it
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]414</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if the call was successful, or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]415</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderGetParserProp"></a>xmlTextReaderGetParserProp ()</h3><pre class="programlisting">int xmlTextReaderGetParserProp (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
416 int prop);</pre><p>
417Read the parser internal property.</p><p>
418
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]419</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
420</td></tr><tr><td><span class="term"><i><tt>prop</tt></i> :</span></td><td> the xmlParserProperties to get
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]421</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the value, usually 0 or 1, or -1 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]422</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderCurrentNode"></a>xmlTextReaderCurrentNode ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> xmlTextReaderCurrentNode (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
423Hacking interface allowing to get the xmlNodePtr correponding to the
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]424current node being accessed by the xmlTextReader. This is dangerous
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]425because the underlying node may be destroyed on the next Reads.</p><p>
426
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]427</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]428</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlNodePtr or NULL in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]429</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderCurrentDoc"></a>xmlTextReaderCurrentDoc ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> xmlTextReaderCurrentDoc (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
430Hacking interface allowing to get the xmlDocPtr correponding to the
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]431current document being accessed by the xmlTextReader. This is dangerous
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]432because the associated node may be destroyed on the next Reads.</p><p>
433
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]434</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]435</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlDocPtr or NULL in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]436</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderExpand"></a>xmlTextReaderExpand ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> xmlTextReaderExpand (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
437Reads the contents of the current node and the full subtree. It then makes
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]438the subtree available until the next <a href="libxml-xmlreader.html#xmlTextReaderRead">xmlTextReaderRead</a>() call</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]439
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]440</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]441</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a node pointer valid until the next <a href="libxml-xmlreader.html#xmlTextReaderRead">xmlTextReaderRead</a>() call
442 or NULL in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]443</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderNext"></a>xmlTextReaderNext ()</h3><pre class="programlisting">int xmlTextReaderNext (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
444Skip to the node following the current one in document order while
445avoiding the subtree if any.</p><p>
446
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]447</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]448</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if the node was read successfully, 0 if there is no more
449 nodes to read, or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]450</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderIsValid"></a>xmlTextReaderIsValid ()</h3><pre class="programlisting">int xmlTextReaderIsValid (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);</pre><p>
451Retrieve the validity status from the parser context</p><p>
452
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]453</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]454</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the flag value 1 if valid, 0 if no, and -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]455</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderRelaxNGValidate"></a>xmlTextReaderRelaxNGValidate ()</h3><pre class="programlisting">int xmlTextReaderRelaxNGValidate (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
456 const char *rng);</pre><p>
457Use RelaxNG to validate the document as it is processed.
458Activation is only possible before the first <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="Read">Read</GTKDOCLINK>().
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]459if <i><tt>rng</tt></i> is NULL, then RelaxNG validation is desactivated.</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]460
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]461</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
462</td></tr><tr><td><span class="term"><i><tt>rng</tt></i> :</span></td><td> the path to a RelaxNG schema or NULL
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]463</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case the RelaxNG validation could be (des)activated and
464 -1 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]465</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderRelaxNGSetSchema"></a>xmlTextReaderRelaxNGSetSchema ()</h3><pre class="programlisting">int xmlTextReaderRelaxNGSetSchema (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
466 <a href="libxml-relaxng.html#xmlRelaxNGPtr">xmlRelaxNGPtr</a> schema);</pre><p>
467Use RelaxNG to validate the document as it is processed.
468Activation is only possible before the first <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="Read">Read</GTKDOCLINK>().
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]469if <i><tt>schema</tt></i> is NULL, then RelaxNG validation is desactivated.
470 @ The <i><tt>schema</tt></i> should not be freed until the reader is deallocated
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]471or its use has been deactivated.</p><p>
472
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]473</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
474</td></tr><tr><td><span class="term"><i><tt>schema</tt></i> :</span></td><td> a precompiled RelaxNG schema
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]475</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case the RelaxNG validation could be (des)activated and
476 -1 in case of error.
477</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderLocatorPtr"></a>xmlTextReaderLocatorPtr</h3><pre class="programlisting">typedef void * xmlTextReaderLocatorPtr;
478</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]479
480</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderErrorFunc"></a>xmlTextReaderErrorFunc ()</h3><pre class="programlisting">void (*xmlTextReaderErrorFunc) (void *arg,
Daniel Veillardaec63562003-03-23 20:42:17 +0000[diff] [blame]481 const char *msg,
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]482 <a href="libxml-xmlreader.html#xmlParserSeverities">xmlParserSeverities</a> severity,
483 <a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a> locator);</pre><p>
484
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]485</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>
486</td></tr><tr><td><span class="term"><i><tt>msg</tt></i> :</span></td><td>
487</td></tr><tr><td><span class="term"><i><tt>severity</tt></i> :</span></td><td>
488</td></tr><tr><td><span class="term"><i><tt>locator</tt></i> :</span></td><td>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]489
490
491</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderLocatorLineNumber"></a>xmlTextReaderLocatorLineNumber ()</h3><pre class="programlisting">int xmlTextReaderLocatorLineNumber (<a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a> locator);</pre><p>
492Obtain the line number for the given locator.</p><p>
493
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]494</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>locator</tt></i> :</span></td><td> the xmlTextReaderLocatorPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]495</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the line number or -1 in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]496</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderLocatorBaseURI"></a>xmlTextReaderLocatorBaseURI ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlTextReaderLocatorBaseURI (<a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a> locator);</pre><p>
497Obtain the base URI for the given locator.</p><p>
498
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]499</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>locator</tt></i> :</span></td><td> the xmlTextReaderLocatorPtr used
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]500</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the base URI or NULL in case of error.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]501</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderSetErrorHandler"></a>xmlTextReaderSetErrorHandler ()</h3><pre class="programlisting">void xmlTextReaderSetErrorHandler (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
502 <a href="libxml-xmlreader.html#xmlTextReaderErrorFunc">xmlTextReaderErrorFunc</a> f,
503 void *arg);</pre><p>
504Register a callback function that will be called on error and warnings.
505</p><p>
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]506If <i><tt>f</tt></i> is NULL, the default error and warning handlers are restored.</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]507
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]508</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
509</td></tr><tr><td><span class="term"><i><tt>f</tt></i> :</span></td><td> the callback function to call on error and warnings
510</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> a user argument to pass to the callback function
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]511</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlTextReaderGetErrorHandler"></a>xmlTextReaderGetErrorHandler ()</h3><pre class="programlisting">void xmlTextReaderGetErrorHandler (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
512 <a href="libxml-xmlreader.html#xmlTextReaderErrorFunc">xmlTextReaderErrorFunc</a> *f,
513 void **arg);</pre><p>
514Retrieve the error callback function and user argument.</p><p>
515
Daniel Veillard2fdbd322003-08-18 12:15:38 +0000[diff] [blame]516</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>reader</tt></i> :</span></td><td> the xmlTextReaderPtr used
517</td></tr><tr><td><span class="term"><i><tt>f</tt></i> :</span></td><td> the callback function or NULL is no callback has been registered
518</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> a user argument
519</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-parser.html"><b>&lt;&lt; parser</b></a></td><td align="right"><a accesskey="n" href="libxml-SAX.html"><b>SAX &gt;&gt;</b></a></td></tr></table></body></html>