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">
2 .synopsis, .classsynopsis {
4 border: solid 1px #aaaaaa;
9 border: solid 1px #aaaaff;
18 border: solid 1px #ffaaaa;
25 .navigation a:visited {
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 — </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
35 enum <a href="libxml-xmlreader.html#xmlParserProperties">xmlParserProperties</a>;
36 enum <a href="libxml-xmlreader.html#xmlParserSeverities">xmlParserSeverities</a>;
37 enum <a href="libxml-xmlreader.html#xmlReaderTypes">xmlReaderTypes</a>;
38 struct <a href="libxml-xmlreader.html#xmlTextReader">xmlTextReader</a>;
39 typedef <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,
42 <a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> <a href="libxml-xmlreader.html#xmlNewTextReaderFilename">xmlNewTextReaderFilename</a> (const char *URI);
43 void <a href="libxml-xmlreader.html#xmlFreeTextReader">xmlFreeTextReader</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
44 int <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);
48 int <a href="libxml-xmlreader.html#xmlTextReaderReadAttributeValue">xmlTextReaderReadAttributeValue</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
49 int <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);
51 int <a href="libxml-xmlreader.html#xmlTextReaderDepth">xmlTextReaderDepth</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
52 int <a href="libxml-xmlreader.html#xmlTextReaderHasAttributes">xmlTextReaderHasAttributes</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
53 int <a href="libxml-xmlreader.html#xmlTextReaderHasValue">xmlTextReaderHasValue</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
54 int <a href="libxml-xmlreader.html#xmlTextReaderIsDefault">xmlTextReaderIsDefault</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
55 int <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);
59 int <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);
61 int <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);
64 int <a href="libxml-xmlreader.html#xmlTextReaderReadState">xmlTextReaderReadState</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
65 int <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,
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);
77 int <a href="libxml-xmlreader.html#xmlTextReaderMoveToAttributeNo">xmlTextReaderMoveToAttributeNo</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
79 int <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);
81 int <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);
84 int <a href="libxml-xmlreader.html#xmlTextReaderMoveToFirstAttribute">xmlTextReaderMoveToFirstAttribute</a>
85 (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
86 int <a href="libxml-xmlreader.html#xmlTextReaderMoveToNextAttribute">xmlTextReaderMoveToNextAttribute</a>
87 (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
88 int <a href="libxml-xmlreader.html#xmlTextReaderMoveToElement">xmlTextReaderMoveToElement</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
89 int <a href="libxml-xmlreader.html#xmlTextReaderNormalization">xmlTextReaderNormalization</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
90 int <a href="libxml-xmlreader.html#xmlTextReaderSetParserProp">xmlTextReaderSetParserProp</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
93 int <a href="libxml-xmlreader.html#xmlTextReaderGetParserProp">xmlTextReaderGetParserProp</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
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);
98 int <a href="libxml-xmlreader.html#xmlTextReaderNext">xmlTextReaderNext</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
99 int <a href="libxml-xmlreader.html#xmlTextReaderIsValid">xmlTextReaderIsValid</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader);
100 int <a href="libxml-xmlreader.html#xmlTextReaderRelaxNGValidate">xmlTextReaderRelaxNGValidate</a> (<a href="libxml-xmlreader.html#xmlTextReaderPtr">xmlTextReaderPtr</a> reader,
102 int <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);
104 typedef <a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a>;
105 void (<a href="libxml-xmlreader.html#xmlTextReaderErrorFunc">*xmlTextReaderErrorFunc</a>) (void *arg,
107 <a href="libxml-xmlreader.html#xmlParserSeverities">xmlParserSeverities</a> severity,
108 <a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a> locator);
109 int <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);
111 void <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,
114 void <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,
117 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
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 {
120 XML_PARSER_LOADDTD = 1,
121 XML_PARSER_DEFAULTATTRS = 2,
122 XML_PARSER_VALIDATE = 3,
123 XML_PARSER_SUBST_ENTITIES = 4
124 } xmlParserProperties;
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 {
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
132 } xmlParserSeverities;
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
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>
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;
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>
164 Create an xmlTextReader structure fed with <i><tt>input</tt></i></p><p>
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
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
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>
170 Create an xmlTextReader structure fed with the resource at <i><tt>URI</tt></i></p><p>
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
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
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>
175 Deallocate all the resources associated to the reader</p><p>
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
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>
179 Moves the position of the current instance to the next node in
180 the stream, exposing its properties.</p><p>
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
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
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>
186 Reads the contents of the current node, including child nodes and markup.</p><p>
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
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.
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>
193 Reads the contents of the current node, including child nodes and markup.</p><p>
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
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.
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>
200 Reads the contents of an element or a text node as a string.</p><p>
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
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.
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>
207 Parses an attribute value into one or more Text and EntityReference nodes.</p><p>
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
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
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>
214 Provides the number of attributes of the current node</p><p>
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
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
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>
219 The base URI of the node.</p><p>
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
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
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>
224 The depth of the node in the tree.</p><p>
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
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
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>
229 Whether the node has attributes.</p><p>
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
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
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>
234 Whether the node can have a text value.</p><p>
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
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
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>
239 Whether an Attribute node was generated from the default value
240 defined in the DTD or schema.</p><p>
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
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
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>
245 Check if the current node is empty</p><p>
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
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
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>
250 The local name of the node.</p><p>
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
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
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>
255 The qualified name of the node, equal to Prefix :LocalName.</p><p>
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
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
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>
260 The URI defining the namespace associated with the node.</p><p>
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
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
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>
265 Get the node type of the current node
267 http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html</p><p>
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
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
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>
272 A shorthand reference to the namespace associated with the node.</p><p>
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
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
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>
277 The quotation mark character used to enclose the value of an attribute.</p><p>
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
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
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>
282 Provides the text value of the node if present</p><p>
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
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>()
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>
288 The xml:lang scope within which the node resides.</p><p>
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
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.
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>
293 Gets the read state of the reader.</p><p>
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
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
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>
298 This method releases any resources allocated by the current instance
299 changes the state to Closed and close any underlying input.</p><p>
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
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
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,
305 Provides the value of the attribute with the specified index relative
306 to the containing element.</p><p>
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
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.
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>
314 Provides the value of the attribute with the specified qualified name.</p><p>
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.
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.
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>
323 Provides the value of the specified attribute</p><p>
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.
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.
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>
332 Method to get the remainder of the buffered XML. this method stops the
333 parser, set its state to End Of File and return the input stream with
334 what is left that the parser did not use.</p><p>
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
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
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>
341 Resolves a namespace prefix in the scope of the current element.</p><p>
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
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.
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,
350 Moves the position of the current instance to the attribute with
351 the specified index relative to the containing element.</p><p>
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
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
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>
359 Moves the position of the current instance to the attribute with
360 the specified qualified name.</p><p>
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.
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
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>
368 Moves the position of the current instance to the attribute with the
369 specified local name and namespace URI.</p><p>
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.
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
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>
377 Moves the position of the current instance to the first attribute
378 associated with the current node.</p><p>
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
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
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>
384 Moves the position of the current instance to the next attribute
385 associated with the current node.</p><p>
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
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
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>
390 Moves the position of the current instance to the node that
391 contains the current Attribute node.</p><p>
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
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
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>
396 The value indicating whether to normalize white space and attribute values.
397 Since attribute value and end of line normalizations are a MUST in the XML
398 specification only the value true is accepted. The broken bahaviour of
399 accepting out of range character entities like &<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="0-CAPS">0</GTKDOCLINK>; is of course not
400 supported either.</p><p>
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
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.
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,
407 Change the parser processing behaviour by changing some of its internal
408 properties. Note that some properties can only be changed before any
409 read has been done.</p><p>
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
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
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,
417 Read the parser internal property.</p><p>
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
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.
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>
423 Hacking interface allowing to get the xmlNodePtr correponding to the
424 current node being accessed by the xmlTextReader. This is dangerous
425 because the underlying node may be destroyed on the next Reads.</p><p>
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
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.
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>
430 Hacking interface allowing to get the xmlDocPtr correponding to the
431 current document being accessed by the xmlTextReader. This is dangerous
432 because the associated node may be destroyed on the next Reads.</p><p>
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
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.
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>
437 Reads the contents of the current node and the full subtree. It then makes
438 the subtree available until the next <a href="libxml-xmlreader.html#xmlTextReaderRead">xmlTextReaderRead</a>() call</p><p>
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
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.
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>
444 Skip to the node following the current one in document order while
445 avoiding the subtree if any.</p><p>
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
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
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>
451 Retrieve the validity status from the parser context</p><p>
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
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
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>
457 Use RelaxNG to validate the document as it is processed.
458 Activation is only possible before the first <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="Read">Read</GTKDOCLINK>().
459 if <i><tt>rng</tt></i> is NULL, then RelaxNG validation is desactivated.</p><p>
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
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
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>
467 Use RelaxNG to validate the document as it is processed.
468 Activation is only possible before the first <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="Read">Read</GTKDOCLINK>().
469 if <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
471 or its use has been deactivated.</p><p>
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
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
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;
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,
482 <a href="libxml-xmlreader.html#xmlParserSeverities">xmlParserSeverities</a> severity,
483 <a href="libxml-xmlreader.html#xmlTextReaderLocatorPtr">xmlTextReaderLocatorPtr</a> locator);</pre><p>
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>
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>
492 Obtain the line number for the given locator.</p><p>
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
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.
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>
497 Obtain the base URI for the given locator.</p><p>
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
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.
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,
504 Register a callback function that will be called on error and warnings.
506 If <i><tt>f</tt></i> is NULL, the default error and warning handlers are restored.</p><p>
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
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>
514 Retrieve the error callback function and user argument.</p><p>
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><< parser</b></a></td><td align="right"><a accesskey="n" href="libxml-SAX.html"><b>SAX >></b></a></td></tr></table></body></html>