kc3-lang/libxml2/doc/html/libxml-SAX.html
-
Show log
Commit
-
Hash : d7cec926
Author :
Date : 2003-06-13T12:30:10
reverted back patch for #113521, due to #115104 and while fixing #115101 . * doc/Makefile.am doc/html/*: reverted back patch for #113521, due to #115104 and while fixing #115101 . HTML URLs must not be version dependant. Daniel
-
doc/html/libxml-SAX.html
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>SAX</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css"> .synopsis, .classsynopsis { background: #eeeeee; border: solid 1px #aaaaaa; padding: 0.5em; } .programlisting { background: #eeeeff; border: solid 1px #aaaaff; padding: 0.5em; } .variablelist { padding: 4px; margin-left: 3em; } .navigation { background: #ffeeee; border: solid 1px #ffaaaa; margin-top: 0.5em; margin-bottom: 0.5em; } .navigation a { color: #770000; } .navigation a:visited { color: #550000; } .navigation .title { font-size: 200%; } </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-xmlreader.html" title="xmlreader"><link rel="next" href="libxml-tree.html" title="tree"></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-xmlreader.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-tree.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-SAX"></a><div class="titlepage"></div><div class="refnamediv"><h2>SAX</h2><p>SAX — </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis"> const <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-SAX.html#getPublicId">getPublicId</a> (void *ctx); const <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-SAX.html#getSystemId">getSystemId</a> (void *ctx); void <a href="libxml-SAX.html#setDocumentLocator">setDocumentLocator</a> (void *ctx, <a href="libxml-tree.html#xmlSAXLocatorPtr">xmlSAXLocatorPtr</a> loc); int <a href="libxml-SAX.html#getLineNumber">getLineNumber</a> (void *ctx); int <a href="libxml-SAX.html#getColumnNumber">getColumnNumber</a> (void *ctx); int <a href="libxml-SAX.html#isStandalone">isStandalone</a> (void *ctx); int <a href="libxml-SAX.html#hasInternalSubset">hasInternalSubset</a> (void *ctx); int <a href="libxml-SAX.html#hasExternalSubset">hasExternalSubset</a> (void *ctx); void <a href="libxml-SAX.html#internalSubset">internalSubset</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID); void <a href="libxml-SAX.html#externalSubset">externalSubset</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID); <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-SAX.html#getEntity">getEntity</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-SAX.html#getParameterEntity">getParameterEntity</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-SAX.html#resolveEntity">resolveEntity</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId); void <a href="libxml-SAX.html#entityDecl">entityDecl</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, int type, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId, <a href="libxml-tree.html#xmlChar">xmlChar</a> *content); void <a href="libxml-SAX.html#attributeDecl">attributeDecl</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *elem, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *fullname, int type, int def, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *defaultValue, <a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> tree); void <a href="libxml-SAX.html#elementDecl">elementDecl</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, int type, <a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> content); void <a href="libxml-SAX.html#notationDecl">notationDecl</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId); void <a href="libxml-SAX.html#unparsedEntityDecl">unparsedEntityDecl</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *notationName); void <a href="libxml-SAX.html#startDocument">startDocument</a> (void *ctx); void <a href="libxml-SAX.html#endDocument">endDocument</a> (void *ctx); void <a href="libxml-SAX.html#attribute">attribute</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *fullname, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value); void <a href="libxml-SAX.html#startElement">startElement</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *fullname, const <a href="libxml-tree.html#xmlChar">xmlChar</a> **atts); void <a href="libxml-SAX.html#endElement">endElement</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); void <a href="libxml-SAX.html#reference">reference</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); void <a href="libxml-SAX.html#characters">characters</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ch, int len); void <a href="libxml-SAX.html#ignorableWhitespace">ignorableWhitespace</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ch, int len); void <a href="libxml-SAX.html#processingInstruction">processingInstruction</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *target, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *data); void <a href="libxml-SAX.html#globalNamespace">globalNamespace</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *href, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *prefix); void <a href="libxml-SAX.html#setNamespace">setNamespace</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name); <a href="libxml-tree.html#xmlNsPtr">xmlNsPtr</a> <a href="libxml-SAX.html#getNamespace">getNamespace</a> (void *ctx); int <a href="libxml-SAX.html#checkNamespace">checkNamespace</a> (void *ctx, <a href="libxml-tree.html#xmlChar">xmlChar</a> *nameSpace); void <a href="libxml-SAX.html#namespaceDecl">namespaceDecl</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *href, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *prefix); void <a href="libxml-SAX.html#comment">comment</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value); void <a href="libxml-SAX.html#cdataBlock">cdataBlock</a> (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value, int len); void <a href="libxml-SAX.html#initxmlDefaultSAXHandler">initxmlDefaultSAXHandler</a> (<a href="libxml-parser.html#xmlSAXHandler">xmlSAXHandler</a> *hdlr, int warning); void <a href="libxml-SAX.html#inithtmlDefaultSAXHandler">inithtmlDefaultSAXHandler</a> (<a href="libxml-parser.html#xmlSAXHandler">xmlSAXHandler</a> *hdlr); void <a href="libxml-SAX.html#initdocbDefaultSAXHandler">initdocbDefaultSAXHandler</a> (<a href="libxml-parser.html#xmlSAXHandler">xmlSAXHandler</a> *hdlr); void <a href="libxml-SAX.html#xmlDefaultSAXHandlerInit">xmlDefaultSAXHandlerInit</a> (void); void <a href="libxml-SAX.html#htmlDefaultSAXHandlerInit">htmlDefaultSAXHandlerInit</a> (void); void <a href="libxml-SAX.html#docbDefaultSAXHandlerInit">docbDefaultSAXHandlerInit</a> (void); </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p> </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="getPublicId"></a>getPublicId ()</h3><pre class="programlisting">const <a href="libxml-tree.html#xmlChar">xmlChar</a>* getPublicId (void *ctx);</pre><p> Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a xmlChar * </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="getSystemId"></a>getSystemId ()</h3><pre class="programlisting">const <a href="libxml-tree.html#xmlChar">xmlChar</a>* getSystemId (void *ctx);</pre><p> Provides the system ID, basically URL or filename e.g. http://www.sgmlsource.com/dtds/memo.dtd</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a xmlChar * </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="setDocumentLocator"></a>setDocumentLocator ()</h3><pre class="programlisting">void setDocumentLocator (void *ctx, <a href="libxml-tree.html#xmlSAXLocatorPtr">xmlSAXLocatorPtr</a> loc);</pre><p> Receive the document locator at startup, actually xmlDefaultSAXLocator Everything is available on the context, so this is useless in our case.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>loc</tt></i> :</span></td><td> A SAX Locator </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="getLineNumber"></a>getLineNumber ()</h3><pre class="programlisting">int getLineNumber (void *ctx);</pre><p> Provide the line number of the current parsing point.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>an int </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="getColumnNumber"></a>getColumnNumber ()</h3><pre class="programlisting">int getColumnNumber (void *ctx);</pre><p> Provide the column number of the current parsing point.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>an int </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="isStandalone"></a>isStandalone ()</h3><pre class="programlisting">int isStandalone (void *ctx);</pre><p> Is this document tagged standalone ?</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="hasInternalSubset"></a>hasInternalSubset ()</h3><pre class="programlisting">int hasInternalSubset (void *ctx);</pre><p> Does this document has an internal subset</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="hasExternalSubset"></a>hasExternalSubset ()</h3><pre class="programlisting">int hasExternalSubset (void *ctx);</pre><p> Does this document has an external subset</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="internalSubset"></a>internalSubset ()</h3><pre class="programlisting">void internalSubset (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);</pre><p> Callback on internal subset declaration.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the root element name </td></tr><tr><td><span class="term"><i><tt>ExternalID</tt></i> :</span></td><td> the external ID </td></tr><tr><td><span class="term"><i><tt>SystemID</tt></i> :</span></td><td> the SYSTEM ID (e.g. filename or URL) </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="externalSubset"></a>externalSubset ()</h3><pre class="programlisting">void externalSubset (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);</pre><p> Callback on external subset declaration.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the root element name </td></tr><tr><td><span class="term"><i><tt>ExternalID</tt></i> :</span></td><td> the external ID </td></tr><tr><td><span class="term"><i><tt>SystemID</tt></i> :</span></td><td> the SYSTEM ID (e.g. filename or URL) </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="getEntity"></a>getEntity ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> getEntity (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p> Get an entity by name</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> The entity name </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlEntityPtr if found. </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="getParameterEntity"></a>getParameterEntity ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> getParameterEntity (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p> Get a parameter entity by name</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> The entity name </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlEntityPtr if found. </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="resolveEntity"></a>resolveEntity ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> resolveEntity (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId);</pre><p> The entity loader, to control the loading of external entities, the application can either: - override this <a href="libxml-SAX.html#resolveEntity">resolveEntity</a>() callback in the SAX block - or better use the <a href="libxml-parser.html#xmlSetExternalEntityLoader">xmlSetExternalEntityLoader</a>() function to set up it's own entity resolution routine</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>publicId</tt></i> :</span></td><td> The public ID of the entity </td></tr><tr><td><span class="term"><i><tt>systemId</tt></i> :</span></td><td> The system ID of the entity </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlParserInputPtr if inlined or NULL for DOM behaviour. </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="entityDecl"></a>entityDecl ()</h3><pre class="programlisting">void entityDecl (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, int type, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId, <a href="libxml-tree.html#xmlChar">xmlChar</a> *content);</pre><p> An entity definition has been parsed</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the entity name </td></tr><tr><td><span class="term"><i><tt>type</tt></i> :</span></td><td> the entity type </td></tr><tr><td><span class="term"><i><tt>publicId</tt></i> :</span></td><td> The public ID of the entity </td></tr><tr><td><span class="term"><i><tt>systemId</tt></i> :</span></td><td> The system ID of the entity </td></tr><tr><td><span class="term"><i><tt>content</tt></i> :</span></td><td> the entity value (without processing). </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="attributeDecl"></a>attributeDecl ()</h3><pre class="programlisting">void attributeDecl (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *elem, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *fullname, int type, int def, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *defaultValue, <a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> tree);</pre><p> An attribute definition has been parsed</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>elem</tt></i> :</span></td><td> the name of the element </td></tr><tr><td><span class="term"><i><tt>fullname</tt></i> :</span></td><td> the attribute name </td></tr><tr><td><span class="term"><i><tt>type</tt></i> :</span></td><td> the attribute type </td></tr><tr><td><span class="term"><i><tt>def</tt></i> :</span></td><td> the type of default value </td></tr><tr><td><span class="term"><i><tt>defaultValue</tt></i> :</span></td><td> the attribute default value </td></tr><tr><td><span class="term"><i><tt>tree</tt></i> :</span></td><td> the tree of enumerated value set </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="elementDecl"></a>elementDecl ()</h3><pre class="programlisting">void elementDecl (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, int type, <a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> content);</pre><p> An element definition has been parsed</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the element name </td></tr><tr><td><span class="term"><i><tt>type</tt></i> :</span></td><td> the element type </td></tr><tr><td><span class="term"><i><tt>content</tt></i> :</span></td><td> the element value tree </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="notationDecl"></a>notationDecl ()</h3><pre class="programlisting">void notationDecl (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId);</pre><p> What to do when a notation declaration has been parsed.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> The name of the notation </td></tr><tr><td><span class="term"><i><tt>publicId</tt></i> :</span></td><td> The public ID of the entity </td></tr><tr><td><span class="term"><i><tt>systemId</tt></i> :</span></td><td> The system ID of the entity </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="unparsedEntityDecl"></a>unparsedEntityDecl ()</h3><pre class="programlisting">void unparsedEntityDecl (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *publicId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *systemId, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *notationName);</pre><p> What to do when an unparsed entity declaration is parsed</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> The name of the entity </td></tr><tr><td><span class="term"><i><tt>publicId</tt></i> :</span></td><td> The public ID of the entity </td></tr><tr><td><span class="term"><i><tt>systemId</tt></i> :</span></td><td> The system ID of the entity </td></tr><tr><td><span class="term"><i><tt>notationName</tt></i> :</span></td><td> the name of the notation </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="startDocument"></a>startDocument ()</h3><pre class="programlisting">void startDocument (void *ctx);</pre><p> called when the document start being processed.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="endDocument"></a>endDocument ()</h3><pre class="programlisting">void endDocument (void *ctx);</pre><p> called when the document end has been detected.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="attribute"></a>attribute ()</h3><pre class="programlisting">void attribute (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *fullname, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);</pre><p> Handle an attribute that has been read by the parser. The default handling is to convert the attribute into an DOM subtree and past it in a new xmlAttr element added to the element.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>fullname</tt></i> :</span></td><td> The attribute name, including namespace prefix </td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> The attribute value </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="startElement"></a>startElement ()</h3><pre class="programlisting">void startElement (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *fullname, const <a href="libxml-tree.html#xmlChar">xmlChar</a> **atts);</pre><p> called when an opening tag has been processed.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>fullname</tt></i> :</span></td><td> The element name, including namespace prefix </td></tr><tr><td><span class="term"><i><tt>atts</tt></i> :</span></td><td> An array of name/value attributes pairs, NULL terminated </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="endElement"></a>endElement ()</h3><pre class="programlisting">void endElement (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p> called when the end of an element has been detected.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> The element name </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="reference"></a>reference ()</h3><pre class="programlisting">void reference (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p> called when an entity reference is detected.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> The entity name </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="characters"></a>characters ()</h3><pre class="programlisting">void characters (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ch, int len);</pre><p> receiving some chars from the parser.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>ch</tt></i> :</span></td><td> a xmlChar string </td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> the number of xmlChar </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="ignorableWhitespace"></a>ignorableWhitespace ()</h3><pre class="programlisting">void ignorableWhitespace (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ch, int len);</pre><p> receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use characters</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>ch</tt></i> :</span></td><td> a xmlChar string </td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> the number of xmlChar </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="processingInstruction"></a>processingInstruction ()</h3><pre class="programlisting">void processingInstruction (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *target, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *data);</pre><p> A processing instruction has been parsed.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>target</tt></i> :</span></td><td> the target name </td></tr><tr><td><span class="term"><i><tt>data</tt></i> :</span></td><td> the PI data's </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="globalNamespace"></a>globalNamespace ()</h3><pre class="programlisting">void globalNamespace (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *href, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *prefix);</pre><p> An old global namespace has been parsed.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>href</tt></i> :</span></td><td> the namespace associated URN </td></tr><tr><td><span class="term"><i><tt>prefix</tt></i> :</span></td><td> the namespace prefix </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="setNamespace"></a>setNamespace ()</h3><pre class="programlisting">void setNamespace (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p> Set the current element namespace.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the namespace prefix </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="getNamespace"></a>getNamespace ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlNsPtr">xmlNsPtr</a> getNamespace (void *ctx);</pre><p> Get the current element namespace.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlNsPtr or NULL if none </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="checkNamespace"></a>checkNamespace ()</h3><pre class="programlisting">int checkNamespace (void *ctx, <a href="libxml-tree.html#xmlChar">xmlChar</a> *nameSpace);</pre><p> Check that the current element namespace is the same as the one read upon parsing.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>nameSpace</tt></i> :</span></td><td> the namespace to check against </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if true 0 otherwise </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="namespaceDecl"></a>namespaceDecl ()</h3><pre class="programlisting">void namespaceDecl (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *href, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *prefix);</pre><p> A namespace has been parsed.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>href</tt></i> :</span></td><td> the namespace associated URN </td></tr><tr><td><span class="term"><i><tt>prefix</tt></i> :</span></td><td> the namespace prefix </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="comment"></a>comment ()</h3><pre class="programlisting">void comment (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);</pre><p> A comment has been parsed.</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> the comment content </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="cdataBlock"></a>cdataBlock ()</h3><pre class="programlisting">void cdataBlock (void *ctx, const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value, int len);</pre><p> called when a pcdata block has been parsed</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctx</tt></i> :</span></td><td> the user data (XML parser context) </td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> The pcdata content </td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> the block length </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="initxmlDefaultSAXHandler"></a>initxmlDefaultSAXHandler ()</h3><pre class="programlisting">void initxmlDefaultSAXHandler (<a href="libxml-parser.html#xmlSAXHandler">xmlSAXHandler</a> *hdlr, int warning);</pre><p> Initialize the default XML SAX handler</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>hdlr</tt></i> :</span></td><td> the SAX handler </td></tr><tr><td><span class="term"><i><tt>warning</tt></i> :</span></td><td> flag if non-zero sets the handler warning procedure </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="inithtmlDefaultSAXHandler"></a>inithtmlDefaultSAXHandler ()</h3><pre class="programlisting">void inithtmlDefaultSAXHandler (<a href="libxml-parser.html#xmlSAXHandler">xmlSAXHandler</a> *hdlr);</pre><p> Initialize the default HTML SAX handler</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>hdlr</tt></i> :</span></td><td> the SAX handler </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="initdocbDefaultSAXHandler"></a>initdocbDefaultSAXHandler ()</h3><pre class="programlisting">void initdocbDefaultSAXHandler (<a href="libxml-parser.html#xmlSAXHandler">xmlSAXHandler</a> *hdlr);</pre><p> Initialize the default DocBook SAX handler</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>hdlr</tt></i> :</span></td><td> the SAX handler </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDefaultSAXHandlerInit"></a>xmlDefaultSAXHandlerInit ()</h3><pre class="programlisting">void xmlDefaultSAXHandlerInit (void);</pre><p> Initialize the default SAX handler</p><p> </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="htmlDefaultSAXHandlerInit"></a>htmlDefaultSAXHandlerInit ()</h3><pre class="programlisting">void htmlDefaultSAXHandlerInit (void);</pre><p> Initialize the default SAX handler</p><p> </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="docbDefaultSAXHandlerInit"></a>docbDefaultSAXHandlerInit ()</h3><pre class="programlisting">void docbDefaultSAXHandlerInit (void);</pre><p> Initialize the default SAX handler</p><p> </p></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-xmlreader.html"><b><< xmlreader</b></a></td><td align="right"><a accesskey="n" href="libxml-tree.html"><b>tree >></b></a></td></tr></table></body></html>