1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>SAX: Old SAX version 1 handler, deprecated</title> 5<meta name="generator" content="Libxml2 devhelp stylesheet"> 6<link rel="start" href="index.html" title="libxml2 Reference Manual"> 7<link rel="up" href="general.html" title="API"> 8<link rel="stylesheet" href="style.css" type="text/css"> 9<link rel="chapter" href="general.html" title="API"> 10</head> 11<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 12<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> 13<td><a accesskey="p" href="libxml2-HTMLtree.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> 14<td><a accesskey="u" href="general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> 15<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> 16<td><a accesskey="n" href="libxml2-SAX2.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> 17<th width="100%" align="center">libxml2 Reference Manual</th> 18</tr></table> 19<h2><span class="refentrytitle">SAX</span></h2> 20<p>SAX - Old SAX version 1 handler, deprecated</p> 21<p>DEPRECATED set of SAX version 1 interfaces used to build the DOM tree. </p> 22<p> WARNING: this module is deprecated !</p> 23<p>Author(s): Daniel Veillard </p> 24<div class="refsynopsisdiv"> 25<h2>Synopsis</h2> 26<pre class="synopsis">void <a href="#attribute">attribute</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * fullname, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value); 27void <a href="#attributeDecl">attributeDecl</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * elem, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * fullname, <br> int type, <br> int def, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * defaultValue, <br> <a href="libxml2-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> tree); 28void <a href="#cdataBlock">cdataBlock</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value, <br> int len); 29void <a href="#characters">characters</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ch, <br> int len); 30int <a href="#checkNamespace">checkNamespace</a> (void * ctx, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * namespace); 31void <a href="#comment">comment</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value); 32void <a href="#elementDecl">elementDecl</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> int type, <br> <a href="libxml2-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> content); 33void <a href="#endDocument">endDocument</a> (void * ctx); 34void <a href="#endElement">endElement</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name); 35void <a href="#entityDecl">entityDecl</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> int type, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * publicId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * systemId, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content); 36void <a href="#externalSubset">externalSubset</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID); 37int <a href="#getColumnNumber">getColumnNumber</a> (void * ctx); 38<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="#getEntity">getEntity</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name); 39int <a href="#getLineNumber">getLineNumber</a> (void * ctx); 40<a href="libxml2-tree.html#xmlNsPtr">xmlNsPtr</a> <a href="#getNamespace">getNamespace</a> (void * ctx); 41<a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="#getParameterEntity">getParameterEntity</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name); 42const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * <a href="#getPublicId">getPublicId</a> (void * ctx); 43const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * <a href="#getSystemId">getSystemId</a> (void * ctx); 44void <a href="#globalNamespace">globalNamespace</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * href, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix); 45int <a href="#hasExternalSubset">hasExternalSubset</a> (void * ctx); 46int <a href="#hasInternalSubset">hasInternalSubset</a> (void * ctx); 47void <a href="#ignorableWhitespace">ignorableWhitespace</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ch, <br> int len); 48void <a href="#inithtmlDefaultSAXHandler">inithtmlDefaultSAXHandler</a> (<a href="libxml2-parser.html#xmlSAXHandlerV1">xmlSAXHandlerV1</a> * hdlr); 49void <a href="#initxmlDefaultSAXHandler">initxmlDefaultSAXHandler</a> (<a href="libxml2-parser.html#xmlSAXHandlerV1">xmlSAXHandlerV1</a> * hdlr, <br> int warning); 50void <a href="#internalSubset">internalSubset</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID); 51int <a href="#isStandalone">isStandalone</a> (void * ctx); 52void <a href="#namespaceDecl">namespaceDecl</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * href, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix); 53void <a href="#notationDecl">notationDecl</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * publicId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * systemId); 54void <a href="#processingInstruction">processingInstruction</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * target, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * data); 55void <a href="#reference">reference</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name); 56<a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="#resolveEntity">resolveEntity</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * publicId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * systemId); 57void <a href="#setDocumentLocator">setDocumentLocator</a> (void * ctx, <br> <a href="libxml2-tree.html#xmlSAXLocatorPtr">xmlSAXLocatorPtr</a> loc); 58void <a href="#setNamespace">setNamespace</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name); 59void <a href="#startDocument">startDocument</a> (void * ctx); 60void <a href="#startElement">startElement</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * fullname, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> ** atts); 61void <a href="#unparsedEntityDecl">unparsedEntityDecl</a> (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * publicId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * systemId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * notationName); 62</pre> 63</div> 64<div class="refsect1" lang="en"><h2>Description</h2></div> 65<div class="refsect1" lang="en"> 66<h2>Details</h2> 67<div class="refsect2" lang="en"> 68<div class="refsect2" lang="en"> 69<h3> 70<a name="attribute"></a>attribute ()</h3> 71<pre class="programlisting">void attribute (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * fullname, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value)<br> 72</pre> 73<p>Handle an <a href="libxml2-SAX.html#attribute">attribute</a> that has been read by the parser. The default handling is to convert the <a href="libxml2-SAX.html#attribute">attribute</a> into an DOM subtree and past it in a new <a href="libxml2-tree.html#xmlAttr">xmlAttr</a> element added to the element. DEPRECATED: use xmlSAX2Attribute()</p> 74<div class="variablelist"><table border="0"> 75<col align="left"> 76<tbody> 77<tr> 78<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 79<td>the user data (XML parser context)</td> 80</tr> 81<tr> 82<td><span class="term"><i><tt>fullname</tt></i>:</span></td> 83<td>The <a href="libxml2-SAX.html#attribute">attribute</a> name, including namespace prefix</td> 84</tr> 85<tr> 86<td><span class="term"><i><tt>value</tt></i>:</span></td> 87<td>The <a href="libxml2-SAX.html#attribute">attribute</a> value</td> 88</tr> 89</tbody> 90</table></div> 91</div> 92<hr> 93<div class="refsect2" lang="en"> 94<h3> 95<a name="attributeDecl"></a>attributeDecl ()</h3> 96<pre class="programlisting">void attributeDecl (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * elem, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * fullname, <br> int type, <br> int def, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * defaultValue, <br> <a href="libxml2-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> tree)<br> 97</pre> 98<p>An <a href="libxml2-SAX.html#attribute">attribute</a> definition has been parsed DEPRECATED: use xmlSAX2AttributeDecl()</p> 99<div class="variablelist"><table border="0"> 100<col align="left"> 101<tbody> 102<tr> 103<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 104<td>the user data (XML parser context)</td> 105</tr> 106<tr> 107<td><span class="term"><i><tt>elem</tt></i>:</span></td> 108<td>the name of the element</td> 109</tr> 110<tr> 111<td><span class="term"><i><tt>fullname</tt></i>:</span></td> 112<td>the <a href="libxml2-SAX.html#attribute">attribute</a> name</td> 113</tr> 114<tr> 115<td><span class="term"><i><tt>type</tt></i>:</span></td> 116<td>the <a href="libxml2-SAX.html#attribute">attribute</a> type</td> 117</tr> 118<tr> 119<td><span class="term"><i><tt>def</tt></i>:</span></td> 120<td>the type of default value</td> 121</tr> 122<tr> 123<td><span class="term"><i><tt>defaultValue</tt></i>:</span></td> 124<td>the <a href="libxml2-SAX.html#attribute">attribute</a> default value</td> 125</tr> 126<tr> 127<td><span class="term"><i><tt>tree</tt></i>:</span></td> 128<td>the tree of enumerated value set</td> 129</tr> 130</tbody> 131</table></div> 132</div> 133<hr> 134<div class="refsect2" lang="en"> 135<h3> 136<a name="cdataBlock"></a>cdataBlock ()</h3> 137<pre class="programlisting">void cdataBlock (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value, <br> int len)<br> 138</pre> 139<p>called when a pcdata block has been parsed DEPRECATED: use xmlSAX2CDataBlock()</p> 140<div class="variablelist"><table border="0"> 141<col align="left"> 142<tbody> 143<tr> 144<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 145<td>the user data (XML parser context)</td> 146</tr> 147<tr> 148<td><span class="term"><i><tt>value</tt></i>:</span></td> 149<td>The pcdata content</td> 150</tr> 151<tr> 152<td><span class="term"><i><tt>len</tt></i>:</span></td> 153<td>the block length</td> 154</tr> 155</tbody> 156</table></div> 157</div> 158<hr> 159<div class="refsect2" lang="en"> 160<h3> 161<a name="characters"></a>characters ()</h3> 162<pre class="programlisting">void characters (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ch, <br> int len)<br> 163</pre> 164<p>receiving some chars from the parser. DEPRECATED: use xmlSAX2Characters()</p> 165<div class="variablelist"><table border="0"> 166<col align="left"> 167<tbody> 168<tr> 169<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 170<td>the user data (XML parser context)</td> 171</tr> 172<tr> 173<td><span class="term"><i><tt>ch</tt></i>:</span></td> 174<td>a <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> string</td> 175</tr> 176<tr> 177<td><span class="term"><i><tt>len</tt></i>:</span></td> 178<td>the number of <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> 179</td> 180</tr> 181</tbody> 182</table></div> 183</div> 184<hr> 185<div class="refsect2" lang="en"> 186<h3> 187<a name="checkNamespace"></a>checkNamespace ()</h3> 188<pre class="programlisting">int checkNamespace (void * ctx, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * namespace)<br> 189</pre> 190<p>Check that the current element namespace is the same as the one read upon parsing. DEPRECATED</p> 191<div class="variablelist"><table border="0"> 192<col align="left"> 193<tbody> 194<tr> 195<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 196<td>the user data (XML parser context)</td> 197</tr> 198<tr> 199<td><span class="term"><i><tt>namespace</tt></i>:</span></td> 200<td>the namespace to check against</td> 201</tr> 202<tr> 203<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 204<td>1 if true 0 otherwise</td> 205</tr> 206</tbody> 207</table></div> 208</div> 209<hr> 210<div class="refsect2" lang="en"> 211<h3> 212<a name="comment"></a>comment ()</h3> 213<pre class="programlisting">void comment (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * value)<br> 214</pre> 215<p>A <a href="libxml2-SAX.html#comment">comment</a> has been parsed. DEPRECATED: use xmlSAX2Comment()</p> 216<div class="variablelist"><table border="0"> 217<col align="left"> 218<tbody> 219<tr> 220<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 221<td>the user data (XML parser context)</td> 222</tr> 223<tr> 224<td><span class="term"><i><tt>value</tt></i>:</span></td> 225<td>the <a href="libxml2-SAX.html#comment">comment</a> content</td> 226</tr> 227</tbody> 228</table></div> 229</div> 230<hr> 231<div class="refsect2" lang="en"> 232<h3> 233<a name="elementDecl"></a>elementDecl ()</h3> 234<pre class="programlisting">void elementDecl (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> int type, <br> <a href="libxml2-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> content)<br> 235</pre> 236<p>An element definition has been parsed DEPRECATED: use xmlSAX2ElementDecl()</p> 237<div class="variablelist"><table border="0"> 238<col align="left"> 239<tbody> 240<tr> 241<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 242<td>the user data (XML parser context)</td> 243</tr> 244<tr> 245<td><span class="term"><i><tt>name</tt></i>:</span></td> 246<td>the element name</td> 247</tr> 248<tr> 249<td><span class="term"><i><tt>type</tt></i>:</span></td> 250<td>the element type</td> 251</tr> 252<tr> 253<td><span class="term"><i><tt>content</tt></i>:</span></td> 254<td>the element value tree</td> 255</tr> 256</tbody> 257</table></div> 258</div> 259<hr> 260<div class="refsect2" lang="en"> 261<h3> 262<a name="endDocument"></a>endDocument ()</h3> 263<pre class="programlisting">void endDocument (void * ctx)<br> 264</pre> 265<p>called when the document end has been detected. DEPRECATED: use xmlSAX2EndDocument()</p> 266<div class="variablelist"><table border="0"> 267<col align="left"> 268<tbody><tr> 269<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 270<td>the user data (XML parser context)</td> 271</tr></tbody> 272</table></div> 273</div> 274<hr> 275<div class="refsect2" lang="en"> 276<h3> 277<a name="endElement"></a>endElement ()</h3> 278<pre class="programlisting">void endElement (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br> 279</pre> 280<p>called when the end of an element has been detected. DEPRECATED: use xmlSAX2EndElement()</p> 281<div class="variablelist"><table border="0"> 282<col align="left"> 283<tbody> 284<tr> 285<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 286<td>the user data (XML parser context)</td> 287</tr> 288<tr> 289<td><span class="term"><i><tt>name</tt></i>:</span></td> 290<td>The element name</td> 291</tr> 292</tbody> 293</table></div> 294</div> 295<hr> 296<div class="refsect2" lang="en"> 297<h3> 298<a name="entityDecl"></a>entityDecl ()</h3> 299<pre class="programlisting">void entityDecl (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> int type, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * publicId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * systemId, <br> <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * content)<br> 300</pre> 301<p>An entity definition has been parsed DEPRECATED: use xmlSAX2EntityDecl()</p> 302<div class="variablelist"><table border="0"> 303<col align="left"> 304<tbody> 305<tr> 306<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 307<td>the user data (XML parser context)</td> 308</tr> 309<tr> 310<td><span class="term"><i><tt>name</tt></i>:</span></td> 311<td>the entity name</td> 312</tr> 313<tr> 314<td><span class="term"><i><tt>type</tt></i>:</span></td> 315<td>the entity type</td> 316</tr> 317<tr> 318<td><span class="term"><i><tt>publicId</tt></i>:</span></td> 319<td>The public ID of the entity</td> 320</tr> 321<tr> 322<td><span class="term"><i><tt>systemId</tt></i>:</span></td> 323<td>The system ID of the entity</td> 324</tr> 325<tr> 326<td><span class="term"><i><tt>content</tt></i>:</span></td> 327<td>the entity value (without processing).</td> 328</tr> 329</tbody> 330</table></div> 331</div> 332<hr> 333<div class="refsect2" lang="en"> 334<h3> 335<a name="externalSubset"></a>externalSubset ()</h3> 336<pre class="programlisting">void externalSubset (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID)<br> 337</pre> 338<p>Callback on external subset declaration. DEPRECATED: use xmlSAX2ExternalSubset()</p> 339<div class="variablelist"><table border="0"> 340<col align="left"> 341<tbody> 342<tr> 343<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 344<td>the user data (XML parser context)</td> 345</tr> 346<tr> 347<td><span class="term"><i><tt>name</tt></i>:</span></td> 348<td>the root element name</td> 349</tr> 350<tr> 351<td><span class="term"><i><tt>ExternalID</tt></i>:</span></td> 352<td>the external ID</td> 353</tr> 354<tr> 355<td><span class="term"><i><tt>SystemID</tt></i>:</span></td> 356<td>the SYSTEM ID (e.g. filename or URL)</td> 357</tr> 358</tbody> 359</table></div> 360</div> 361<hr> 362<div class="refsect2" lang="en"> 363<h3> 364<a name="getColumnNumber"></a>getColumnNumber ()</h3> 365<pre class="programlisting">int getColumnNumber (void * ctx)<br> 366</pre> 367<p>Provide the column number of the current parsing point. DEPRECATED: use xmlSAX2GetColumnNumber()</p> 368<div class="variablelist"><table border="0"> 369<col align="left"> 370<tbody> 371<tr> 372<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 373<td>the user data (XML parser context)</td> 374</tr> 375<tr> 376<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 377<td>an int</td> 378</tr> 379</tbody> 380</table></div> 381</div> 382<hr> 383<div class="refsect2" lang="en"> 384<h3> 385<a name="getEntity"></a>getEntity ()</h3> 386<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> getEntity (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br> 387</pre> 388<p>Get an entity by name DEPRECATED: use xmlSAX2GetEntity()</p> 389<div class="variablelist"><table border="0"> 390<col align="left"> 391<tbody> 392<tr> 393<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 394<td>the user data (XML parser context)</td> 395</tr> 396<tr> 397<td><span class="term"><i><tt>name</tt></i>:</span></td> 398<td>The entity name</td> 399</tr> 400<tr> 401<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 402<td>the <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> if found.</td> 403</tr> 404</tbody> 405</table></div> 406</div> 407<hr> 408<div class="refsect2" lang="en"> 409<h3> 410<a name="getLineNumber"></a>getLineNumber ()</h3> 411<pre class="programlisting">int getLineNumber (void * ctx)<br> 412</pre> 413<p>Provide the line number of the current parsing point. DEPRECATED: use xmlSAX2GetLineNumber()</p> 414<div class="variablelist"><table border="0"> 415<col align="left"> 416<tbody> 417<tr> 418<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 419<td>the user data (XML parser context)</td> 420</tr> 421<tr> 422<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 423<td>an int</td> 424</tr> 425</tbody> 426</table></div> 427</div> 428<hr> 429<div class="refsect2" lang="en"> 430<h3> 431<a name="getNamespace"></a>getNamespace ()</h3> 432<pre class="programlisting"><a href="libxml2-tree.html#xmlNsPtr">xmlNsPtr</a> getNamespace (void * ctx)<br> 433</pre> 434<p>Get the current element namespace. DEPRECATED</p> 435<div class="variablelist"><table border="0"> 436<col align="left"> 437<tbody> 438<tr> 439<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 440<td>the user data (XML parser context)</td> 441</tr> 442<tr> 443<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 444<td>the <a href="libxml2-tree.html#xmlNsPtr">xmlNsPtr</a> or NULL if none</td> 445</tr> 446</tbody> 447</table></div> 448</div> 449<hr> 450<div class="refsect2" lang="en"> 451<h3> 452<a name="getParameterEntity"></a>getParameterEntity ()</h3> 453<pre class="programlisting"><a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> getParameterEntity (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br> 454</pre> 455<p>Get a parameter entity by name DEPRECATED: use xmlSAX2GetParameterEntity()</p> 456<div class="variablelist"><table border="0"> 457<col align="left"> 458<tbody> 459<tr> 460<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 461<td>the user data (XML parser context)</td> 462</tr> 463<tr> 464<td><span class="term"><i><tt>name</tt></i>:</span></td> 465<td>The entity name</td> 466</tr> 467<tr> 468<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 469<td>the <a href="libxml2-tree.html#xmlEntityPtr">xmlEntityPtr</a> if found.</td> 470</tr> 471</tbody> 472</table></div> 473</div> 474<hr> 475<div class="refsect2" lang="en"> 476<h3> 477<a name="getPublicId"></a>getPublicId ()</h3> 478<pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * getPublicId (void * ctx)<br> 479</pre> 480<p>Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN" DEPRECATED: use xmlSAX2GetPublicId()</p> 481<div class="variablelist"><table border="0"> 482<col align="left"> 483<tbody> 484<tr> 485<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 486<td>the user data (XML parser context)</td> 487</tr> 488<tr> 489<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 490<td>a <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td> 491</tr> 492</tbody> 493</table></div> 494</div> 495<hr> 496<div class="refsect2" lang="en"> 497<h3> 498<a name="getSystemId"></a>getSystemId ()</h3> 499<pre class="programlisting">const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * getSystemId (void * ctx)<br> 500</pre> 501<p>Provides the system ID, basically URL or filename e.g. http://www.sgmlsource.com/dtds/memo.dtd DEPRECATED: use xmlSAX2GetSystemId()</p> 502<div class="variablelist"><table border="0"> 503<col align="left"> 504<tbody> 505<tr> 506<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 507<td>the user data (XML parser context)</td> 508</tr> 509<tr> 510<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 511<td>a <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> *</td> 512</tr> 513</tbody> 514</table></div> 515</div> 516<hr> 517<div class="refsect2" lang="en"> 518<h3> 519<a name="globalNamespace"></a>globalNamespace ()</h3> 520<pre class="programlisting">void globalNamespace (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * href, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix)<br> 521</pre> 522<p>An old global namespace has been parsed. DEPRECATED</p> 523<div class="variablelist"><table border="0"> 524<col align="left"> 525<tbody> 526<tr> 527<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 528<td>the user data (XML parser context)</td> 529</tr> 530<tr> 531<td><span class="term"><i><tt>href</tt></i>:</span></td> 532<td>the namespace associated URN</td> 533</tr> 534<tr> 535<td><span class="term"><i><tt>prefix</tt></i>:</span></td> 536<td>the namespace prefix</td> 537</tr> 538</tbody> 539</table></div> 540</div> 541<hr> 542<div class="refsect2" lang="en"> 543<h3> 544<a name="hasExternalSubset"></a>hasExternalSubset ()</h3> 545<pre class="programlisting">int hasExternalSubset (void * ctx)<br> 546</pre> 547<p>Does this document has an external subset DEPRECATED: use xmlSAX2HasExternalSubset()</p> 548<div class="variablelist"><table border="0"> 549<col align="left"> 550<tbody> 551<tr> 552<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 553<td>the user data (XML parser context)</td> 554</tr> 555<tr> 556<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 557<td>1 if true</td> 558</tr> 559</tbody> 560</table></div> 561</div> 562<hr> 563<div class="refsect2" lang="en"> 564<h3> 565<a name="hasInternalSubset"></a>hasInternalSubset ()</h3> 566<pre class="programlisting">int hasInternalSubset (void * ctx)<br> 567</pre> 568<p>Does this document has an internal subset DEPRECATED: use xmlSAX2HasInternalSubset()</p> 569<div class="variablelist"><table border="0"> 570<col align="left"> 571<tbody> 572<tr> 573<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 574<td>the user data (XML parser context)</td> 575</tr> 576<tr> 577<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 578<td>1 if true</td> 579</tr> 580</tbody> 581</table></div> 582</div> 583<hr> 584<div class="refsect2" lang="en"> 585<h3> 586<a name="ignorableWhitespace"></a>ignorableWhitespace ()</h3> 587<pre class="programlisting">void ignorableWhitespace (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ch, <br> int len)<br> 588</pre> 589<p>receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use <a href="libxml2-SAX.html#characters">characters</a> DEPRECATED: use xmlSAX2IgnorableWhitespace()</p> 590<div class="variablelist"><table border="0"> 591<col align="left"> 592<tbody> 593<tr> 594<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 595<td>the user data (XML parser context)</td> 596</tr> 597<tr> 598<td><span class="term"><i><tt>ch</tt></i>:</span></td> 599<td>a <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> string</td> 600</tr> 601<tr> 602<td><span class="term"><i><tt>len</tt></i>:</span></td> 603<td>the number of <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> 604</td> 605</tr> 606</tbody> 607</table></div> 608</div> 609<hr> 610<div class="refsect2" lang="en"> 611<h3> 612<a name="inithtmlDefaultSAXHandler"></a>inithtmlDefaultSAXHandler ()</h3> 613<pre class="programlisting">void inithtmlDefaultSAXHandler (<a href="libxml2-parser.html#xmlSAXHandlerV1">xmlSAXHandlerV1</a> * hdlr)<br> 614</pre> 615<p>Initialize the default HTML SAX version 1 handler DEPRECATED: use xmlSAX2InitHtmlDefaultSAXHandler() for the new SAX2 blocks</p> 616<div class="variablelist"><table border="0"> 617<col align="left"> 618<tbody><tr> 619<td><span class="term"><i><tt>hdlr</tt></i>:</span></td> 620<td>the SAX handler</td> 621</tr></tbody> 622</table></div> 623</div> 624<hr> 625<div class="refsect2" lang="en"> 626<h3> 627<a name="initxmlDefaultSAXHandler"></a>initxmlDefaultSAXHandler ()</h3> 628<pre class="programlisting">void initxmlDefaultSAXHandler (<a href="libxml2-parser.html#xmlSAXHandlerV1">xmlSAXHandlerV1</a> * hdlr, <br> int warning)<br> 629</pre> 630<p>Initialize the default XML SAX version 1 handler DEPRECATED: use xmlSAX2InitDefaultSAXHandler() for the new SAX2 blocks</p> 631<div class="variablelist"><table border="0"> 632<col align="left"> 633<tbody> 634<tr> 635<td><span class="term"><i><tt>hdlr</tt></i>:</span></td> 636<td>the SAX handler</td> 637</tr> 638<tr> 639<td><span class="term"><i><tt>warning</tt></i>:</span></td> 640<td>flag if non-zero sets the handler warning procedure</td> 641</tr> 642</tbody> 643</table></div> 644</div> 645<hr> 646<div class="refsect2" lang="en"> 647<h3> 648<a name="internalSubset"></a>internalSubset ()</h3> 649<pre class="programlisting">void internalSubset (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * ExternalID, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * SystemID)<br> 650</pre> 651<p>Callback on internal subset declaration. DEPRECATED: use xmlSAX2InternalSubset()</p> 652<div class="variablelist"><table border="0"> 653<col align="left"> 654<tbody> 655<tr> 656<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 657<td>the user data (XML parser context)</td> 658</tr> 659<tr> 660<td><span class="term"><i><tt>name</tt></i>:</span></td> 661<td>the root element name</td> 662</tr> 663<tr> 664<td><span class="term"><i><tt>ExternalID</tt></i>:</span></td> 665<td>the external ID</td> 666</tr> 667<tr> 668<td><span class="term"><i><tt>SystemID</tt></i>:</span></td> 669<td>the SYSTEM ID (e.g. filename or URL)</td> 670</tr> 671</tbody> 672</table></div> 673</div> 674<hr> 675<div class="refsect2" lang="en"> 676<h3> 677<a name="isStandalone"></a>isStandalone ()</h3> 678<pre class="programlisting">int isStandalone (void * ctx)<br> 679</pre> 680<p>Is this document tagged standalone ? DEPRECATED: use xmlSAX2IsStandalone()</p> 681<div class="variablelist"><table border="0"> 682<col align="left"> 683<tbody> 684<tr> 685<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 686<td>the user data (XML parser context)</td> 687</tr> 688<tr> 689<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 690<td>1 if true</td> 691</tr> 692</tbody> 693</table></div> 694</div> 695<hr> 696<div class="refsect2" lang="en"> 697<h3> 698<a name="namespaceDecl"></a>namespaceDecl ()</h3> 699<pre class="programlisting">void namespaceDecl (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * href, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * prefix)<br> 700</pre> 701<p>A namespace has been parsed. DEPRECATED</p> 702<div class="variablelist"><table border="0"> 703<col align="left"> 704<tbody> 705<tr> 706<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 707<td>the user data (XML parser context)</td> 708</tr> 709<tr> 710<td><span class="term"><i><tt>href</tt></i>:</span></td> 711<td>the namespace associated URN</td> 712</tr> 713<tr> 714<td><span class="term"><i><tt>prefix</tt></i>:</span></td> 715<td>the namespace prefix</td> 716</tr> 717</tbody> 718</table></div> 719</div> 720<hr> 721<div class="refsect2" lang="en"> 722<h3> 723<a name="notationDecl"></a>notationDecl ()</h3> 724<pre class="programlisting">void notationDecl (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * publicId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * systemId)<br> 725</pre> 726<p>What to do when a notation declaration has been parsed. DEPRECATED: use xmlSAX2NotationDecl()</p> 727<div class="variablelist"><table border="0"> 728<col align="left"> 729<tbody> 730<tr> 731<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 732<td>the user data (XML parser context)</td> 733</tr> 734<tr> 735<td><span class="term"><i><tt>name</tt></i>:</span></td> 736<td>The name of the notation</td> 737</tr> 738<tr> 739<td><span class="term"><i><tt>publicId</tt></i>:</span></td> 740<td>The public ID of the entity</td> 741</tr> 742<tr> 743<td><span class="term"><i><tt>systemId</tt></i>:</span></td> 744<td>The system ID of the entity</td> 745</tr> 746</tbody> 747</table></div> 748</div> 749<hr> 750<div class="refsect2" lang="en"> 751<h3> 752<a name="processingInstruction"></a>processingInstruction ()</h3> 753<pre class="programlisting">void processingInstruction (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * target, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * data)<br> 754</pre> 755<p>A processing instruction has been parsed. DEPRECATED: use xmlSAX2ProcessingInstruction()</p> 756<div class="variablelist"><table border="0"> 757<col align="left"> 758<tbody> 759<tr> 760<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 761<td>the user data (XML parser context)</td> 762</tr> 763<tr> 764<td><span class="term"><i><tt>target</tt></i>:</span></td> 765<td>the target name</td> 766</tr> 767<tr> 768<td><span class="term"><i><tt>data</tt></i>:</span></td> 769<td>the PI data's</td> 770</tr> 771</tbody> 772</table></div> 773</div> 774<hr> 775<div class="refsect2" lang="en"> 776<h3> 777<a name="reference"></a>reference ()</h3> 778<pre class="programlisting">void reference (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br> 779</pre> 780<p>called when an entity <a href="libxml2-SAX.html#reference">reference</a> is detected. DEPRECATED: use xmlSAX2Reference()</p> 781<div class="variablelist"><table border="0"> 782<col align="left"> 783<tbody> 784<tr> 785<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 786<td>the user data (XML parser context)</td> 787</tr> 788<tr> 789<td><span class="term"><i><tt>name</tt></i>:</span></td> 790<td>The entity name</td> 791</tr> 792</tbody> 793</table></div> 794</div> 795<hr> 796<div class="refsect2" lang="en"> 797<h3> 798<a name="resolveEntity"></a>resolveEntity ()</h3> 799<pre class="programlisting"><a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> resolveEntity (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * publicId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * systemId)<br> 800</pre> 801<p>The entity loader, to control the loading of external entities, the application can either: - override this resolveEntity() callback in the SAX block - or better use the xmlSetExternalEntityLoader() function to set up it's own entity resolution routine DEPRECATED: use xmlSAX2ResolveEntity()</p> 802<div class="variablelist"><table border="0"> 803<col align="left"> 804<tbody> 805<tr> 806<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 807<td>the user data (XML parser context)</td> 808</tr> 809<tr> 810<td><span class="term"><i><tt>publicId</tt></i>:</span></td> 811<td>The public ID of the entity</td> 812</tr> 813<tr> 814<td><span class="term"><i><tt>systemId</tt></i>:</span></td> 815<td>The system ID of the entity</td> 816</tr> 817<tr> 818<td><span class="term"><i><tt>Returns</tt></i>:</span></td> 819<td>the <a href="libxml2-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> if inlined or NULL for DOM behaviour.</td> 820</tr> 821</tbody> 822</table></div> 823</div> 824<hr> 825<div class="refsect2" lang="en"> 826<h3> 827<a name="setDocumentLocator"></a>setDocumentLocator ()</h3> 828<pre class="programlisting">void setDocumentLocator (void * ctx, <br> <a href="libxml2-tree.html#xmlSAXLocatorPtr">xmlSAXLocatorPtr</a> loc)<br> 829</pre> 830<p>Receive the document locator at startup, actually <a href="libxml2-parser.html#xmlDefaultSAXLocator">xmlDefaultSAXLocator</a> Everything is available on the context, so this is useless in our case. DEPRECATED</p> 831<div class="variablelist"><table border="0"> 832<col align="left"> 833<tbody> 834<tr> 835<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 836<td>the user data (XML parser context)</td> 837</tr> 838<tr> 839<td><span class="term"><i><tt>loc</tt></i>:</span></td> 840<td>A SAX Locator</td> 841</tr> 842</tbody> 843</table></div> 844</div> 845<hr> 846<div class="refsect2" lang="en"> 847<h3> 848<a name="setNamespace"></a>setNamespace ()</h3> 849<pre class="programlisting">void setNamespace (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name)<br> 850</pre> 851<p>Set the current element namespace. DEPRECATED</p> 852<div class="variablelist"><table border="0"> 853<col align="left"> 854<tbody> 855<tr> 856<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 857<td>the user data (XML parser context)</td> 858</tr> 859<tr> 860<td><span class="term"><i><tt>name</tt></i>:</span></td> 861<td>the namespace prefix</td> 862</tr> 863</tbody> 864</table></div> 865</div> 866<hr> 867<div class="refsect2" lang="en"> 868<h3> 869<a name="startDocument"></a>startDocument ()</h3> 870<pre class="programlisting">void startDocument (void * ctx)<br> 871</pre> 872<p>called when the document start being processed. DEPRECATED: use xmlSAX2StartDocument()</p> 873<div class="variablelist"><table border="0"> 874<col align="left"> 875<tbody><tr> 876<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 877<td>the user data (XML parser context)</td> 878</tr></tbody> 879</table></div> 880</div> 881<hr> 882<div class="refsect2" lang="en"> 883<h3> 884<a name="startElement"></a>startElement ()</h3> 885<pre class="programlisting">void startElement (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * fullname, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> ** atts)<br> 886</pre> 887<p>called when an opening tag has been processed. DEPRECATED: use xmlSAX2StartElement()</p> 888<div class="variablelist"><table border="0"> 889<col align="left"> 890<tbody> 891<tr> 892<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 893<td>the user data (XML parser context)</td> 894</tr> 895<tr> 896<td><span class="term"><i><tt>fullname</tt></i>:</span></td> 897<td>The element name, including namespace prefix</td> 898</tr> 899<tr> 900<td><span class="term"><i><tt>atts</tt></i>:</span></td> 901<td>An array of name/value attributes pairs, NULL terminated</td> 902</tr> 903</tbody> 904</table></div> 905</div> 906<hr> 907<div class="refsect2" lang="en"> 908<h3> 909<a name="unparsedEntityDecl"></a>unparsedEntityDecl ()</h3> 910<pre class="programlisting">void unparsedEntityDecl (void * ctx, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * name, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * publicId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * systemId, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * notationName)<br> 911</pre> 912<p>What to do when an unparsed entity declaration is parsed DEPRECATED: use xmlSAX2UnparsedEntityDecl()</p> 913<div class="variablelist"><table border="0"> 914<col align="left"> 915<tbody> 916<tr> 917<td><span class="term"><i><tt>ctx</tt></i>:</span></td> 918<td>the user data (XML parser context)</td> 919</tr> 920<tr> 921<td><span class="term"><i><tt>name</tt></i>:</span></td> 922<td>The name of the entity</td> 923</tr> 924<tr> 925<td><span class="term"><i><tt>publicId</tt></i>:</span></td> 926<td>The public ID of the entity</td> 927</tr> 928<tr> 929<td><span class="term"><i><tt>systemId</tt></i>:</span></td> 930<td>The system ID of the entity</td> 931</tr> 932<tr> 933<td><span class="term"><i><tt>notationName</tt></i>:</span></td> 934<td>the name of the notation</td> 935</tr> 936</tbody> 937</table></div> 938</div> 939<hr> 940</div> 941</div> 942</body> 943</html> 944