libxml2/doc/html/libxml-docbparser.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >DOCBparser</TITLE
   5 ><META
   6 NAME="GENERATOR"
   7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
   8 "><LINK
   9 REL="HOME"
  10 TITLE="Gnome XML Library Reference Manual"
  11 HREF="book1.html"><LINK
  12 REL="UP"
  13 TITLE="Libxml Library Reference"
  14 HREF="libxml-lib.html"><LINK
  15 REL="PREVIOUS"
  16 TITLE="globals"
  17 HREF="libxml-globals.html"><LINK
  18 REL="NEXT"
  19 TITLE="parserInternals"
  20 HREF="libxml-parserinternals.html"></HEAD
  21 ><BODY
  22 CLASS="REFENTRY"
  23 BGCOLOR="#FFFFFF"
  24 TEXT="#000000"
  25 LINK="#0000FF"
  26 VLINK="#840084"
  27 ALINK="#0000FF"
  28 ><DIV
  29 CLASS="NAVHEADER"
  30 ><TABLE
  31 WIDTH="100%"
  32 BORDER="0"
  33 BGCOLOR="#000000"
  34 CELLPADDING="1"
  35 CELLSPACING="0"
  36 ><TR
  37 ><TH
  38 COLSPAN="4"
  39 ALIGN="center"
  40 ><FONT
  41 COLOR="#FFFFFF"
  42 SIZE="5"
  43 >Gnome XML Library Reference Manual</FONT
  44 ></TH
  45 ></TR
  46 ><TR
  47 ><TD
  48 WIDTH="25%"
  49 BGCOLOR="#C00000"
  50 ALIGN="left"
  51 ><A
  52 HREF="libxml-globals.html"
  53 ><FONT
  54 COLOR="#FFFFFF"
  55 SIZE="3"
  56 ><B
  57 >&#60;&#60;&#60; Previous Page</B
  58 ></FONT
  59 ></A
  60 ></TD
  61 ><TD
  62 WIDTH="25%"
  63 BGCOLOR="#0000C0"
  64 ALIGN="center"
  65 ><FONT
  66 COLOR="#FFFFFF"
  67 SIZE="3"
  68 ><B
  69 ><A
  70 HREF="book1.html"
  71 ><FONT
  72 COLOR="#FFFFFF"
  73 SIZE="3"
  74 ><B
  75 >Home</B
  76 ></FONT
  77 ></A
  78 ></B
  79 ></FONT
  80 ></TD
  81 ><TD
  82 WIDTH="25%"
  83 BGCOLOR="#00C000"
  84 ALIGN="center"
  85 ><FONT
  86 COLOR="#FFFFFF"
  87 SIZE="3"
  88 ><B
  89 ><A
  90 HREF="libxml-lib.html"
  91 ><FONT
  92 COLOR="#FFFFFF"
  93 SIZE="3"
  94 ><B
  95 >Up</B
  96 ></FONT
  97 ></A
  98 ></B
  99 ></FONT
 100 ></TD
 101 ><TD
 102 WIDTH="25%"
 103 BGCOLOR="#C00000"
 104 ALIGN="right"
 105 ><A
 106 HREF="libxml-parserinternals.html"
 107 ><FONT
 108 COLOR="#FFFFFF"
 109 SIZE="3"
 110 ><B
 111 >Next Page &#62;&#62;&#62;</B
 112 ></FONT
 113 ></A
 114 ></TD
 115 ></TR
 116 ></TABLE
 117 ></DIV
 118 ><H1
 119 ><A
 120 NAME="LIBXML-DOCBPARSER">DOCBparser</H1
 121 ><DIV
 122 CLASS="REFNAMEDIV"
 123 ><A
 124 NAME="AEN21512"
 125 ></A
 126 ><H2
 127 >Name</H2
 128 >DOCBparser&nbsp;--&nbsp;</DIV
 129 ><DIV
 130 CLASS="REFSYNOPSISDIV"
 131 ><A
 132 NAME="AEN21515"><H2
 133 >Synopsis</H2
 134 ><TABLE
 135 BORDER="0"
 136 BGCOLOR="#D6E8FF"
 137 WIDTH="100%"
 138 CELLPADDING="6"
 139 ><TR
 140 ><TD
 141 ><PRE
 142 CLASS="SYNOPSIS"
 143 >&#13;
 144
 145 typedef     <A
 146 HREF="libxml-docbparser.html#DOCBPARSERCTXT"
 147 >docbParserCtxt</A
 148 >;
 149 typedef     <A
 150 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
 151 >docbParserCtxtPtr</A
 152 >;
 153 typedef     <A
 154 HREF="libxml-docbparser.html#DOCBPARSERNODEINFO"
 155 >docbParserNodeInfo</A
 156 >;
 157 typedef     <A
 158 HREF="libxml-docbparser.html#DOCBSAXHANDLER"
 159 >docbSAXHandler</A
 160 >;
 161 typedef     <A
 162 HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
 163 >docbSAXHandlerPtr</A
 164 >;
 165 typedef     <A
 166 HREF="libxml-docbparser.html#DOCBPARSERINPUT"
 167 >docbParserInput</A
 168 >;
 169 typedef     <A
 170 HREF="libxml-docbparser.html#DOCBPARSERINPUTPTR"
 171 >docbParserInputPtr</A
 172 >;
 173 typedef     <A
 174 HREF="libxml-docbparser.html#DOCBDOCPTR"
 175 >docbDocPtr</A
 176 >;
 177 typedef     <A
 178 HREF="libxml-docbparser.html#DOCBNODEPTR"
 179 >docbNodePtr</A
 180 >;
 181 int         <A
 182 HREF="libxml-docbparser.html#DOCBENCODEENTITIES"
 183 >docbEncodeEntities</A
 184 >              (unsigned char *out,
 185                                              int *outlen,
 186                                              unsigned char *in,
 187                                              int *inlen,
 188                                              int quoteChar);
 189 <A
 190 HREF="libxml-docbparser.html#DOCBDOCPTR"
 191 >docbDocPtr</A
 192 >  <A
 193 HREF="libxml-docbparser.html#DOCBSAXPARSEDOC"
 194 >docbSAXParseDoc</A
 195 >                 (<A
 196 HREF="libxml-tree.html#XMLCHAR"
 197 >xmlChar</A
 198 > *cur,
 199                                              const char *encoding,
 200                                              <A
 201 HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
 202 >docbSAXHandlerPtr</A
 203 > sax,
 204                                              void *userData);
 205 <A
 206 HREF="libxml-docbparser.html#DOCBDOCPTR"
 207 >docbDocPtr</A
 208 >  <A
 209 HREF="libxml-docbparser.html#DOCBPARSEDOC"
 210 >docbParseDoc</A
 211 >                    (<A
 212 HREF="libxml-tree.html#XMLCHAR"
 213 >xmlChar</A
 214 > *cur,
 215                                              const char *encoding);
 216 <A
 217 HREF="libxml-docbparser.html#DOCBDOCPTR"
 218 >docbDocPtr</A
 219 >  <A
 220 HREF="libxml-docbparser.html#DOCBSAXPARSEFILE"
 221 >docbSAXParseFile</A
 222 >                (const char *filename,
 223                                              const char *encoding,
 224                                              <A
 225 HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
 226 >docbSAXHandlerPtr</A
 227 > sax,
 228                                              void *userData);
 229 <A
 230 HREF="libxml-docbparser.html#DOCBDOCPTR"
 231 >docbDocPtr</A
 232 >  <A
 233 HREF="libxml-docbparser.html#DOCBPARSEFILE"
 234 >docbParseFile</A
 235 >                   (const char *filename,
 236                                              const char *encoding);
 237 void        <A
 238 HREF="libxml-docbparser.html#DOCBFREEPARSERCTXT"
 239 >docbFreeParserCtxt</A
 240 >              (<A
 241 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
 242 >docbParserCtxtPtr</A
 243 > ctxt);
 244 <A
 245 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
 246 >docbParserCtxtPtr</A
 247 > <A
 248 HREF="libxml-docbparser.html#DOCBCREATEPUSHPARSERCTXT"
 249 >docbCreatePushParserCtxt</A
 250 >  (<A
 251 HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
 252 >docbSAXHandlerPtr</A
 253 > sax,
 254                                              void *user_data,
 255                                              const char *chunk,
 256                                              int size,
 257                                              const char *filename,
 258                                              <A
 259 HREF="libxml-encoding.html#XMLCHARENCODING"
 260 >xmlCharEncoding</A
 261 > enc);
 262 int         <A
 263 HREF="libxml-docbparser.html#DOCBPARSECHUNK"
 264 >docbParseChunk</A
 265 >                  (<A
 266 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
 267 >docbParserCtxtPtr</A
 268 > ctxt,
 269                                              const char *chunk,
 270                                              int size,
 271                                              int terminate);
 272 <A
 273 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
 274 >docbParserCtxtPtr</A
 275 > <A
 276 HREF="libxml-docbparser.html#DOCBCREATEFILEPARSERCTXT"
 277 >docbCreateFileParserCtxt</A
 278 >  (const char *filename,
 279                                              const char *encoding);
 280 int         <A
 281 HREF="libxml-docbparser.html#DOCBPARSEDOCUMENT"
 282 >docbParseDocument</A
 283 >               (<A
 284 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
 285 >docbParserCtxtPtr</A
 286 > ctxt);</PRE
 287 ></TD
 288 ></TR
 289 ></TABLE
 290 ></DIV
 291 ><DIV
 292 CLASS="REFSECT1"
 293 ><A
 294 NAME="AEN21552"
 295 ></A
 296 ><H2
 297 >Description</H2
 298 ><P
 299 ></P
 300 ></DIV
 301 ><DIV
 302 CLASS="REFSECT1"
 303 ><A
 304 NAME="AEN21555"
 305 ></A
 306 ><H2
 307 >Details</H2
 308 ><DIV
 309 CLASS="REFSECT2"
 310 ><A
 311 NAME="AEN21557"
 312 ></A
 313 ><H3
 314 ><A
 315 NAME="DOCBPARSERCTXT"
 316 ></A
 317 >docbParserCtxt</H3
 318 ><TABLE
 319 BORDER="0"
 320 BGCOLOR="#D6E8FF"
 321 WIDTH="100%"
 322 CELLPADDING="6"
 323 ><TR
 324 ><TD
 325 ><PRE
 326 CLASS="PROGRAMLISTING"
 327 >typedef xmlParserCtxt docbParserCtxt;</PRE
 328 ></TD
 329 ></TR
 330 ></TABLE
 331 ><P
 332 ></P
 333 ></DIV
 334 ><HR><DIV
 335 CLASS="REFSECT2"
 336 ><A
 337 NAME="AEN21562"
 338 ></A
 339 ><H3
 340 ><A
 341 NAME="DOCBPARSERCTXTPTR"
 342 ></A
 343 >docbParserCtxtPtr</H3
 344 ><TABLE
 345 BORDER="0"
 346 BGCOLOR="#D6E8FF"
 347 WIDTH="100%"
 348 CELLPADDING="6"
 349 ><TR
 350 ><TD
 351 ><PRE
 352 CLASS="PROGRAMLISTING"
 353 >typedef xmlParserCtxtPtr docbParserCtxtPtr;</PRE
 354 ></TD
 355 ></TR
 356 ></TABLE
 357 ><P
 358 ></P
 359 ></DIV
 360 ><HR><DIV
 361 CLASS="REFSECT2"
 362 ><A
 363 NAME="AEN21567"
 364 ></A
 365 ><H3
 366 ><A
 367 NAME="DOCBPARSERNODEINFO"
 368 ></A
 369 >docbParserNodeInfo</H3
 370 ><TABLE
 371 BORDER="0"
 372 BGCOLOR="#D6E8FF"
 373 WIDTH="100%"
 374 CELLPADDING="6"
 375 ><TR
 376 ><TD
 377 ><PRE
 378 CLASS="PROGRAMLISTING"
 379 >typedef xmlParserNodeInfo docbParserNodeInfo;</PRE
 380 ></TD
 381 ></TR
 382 ></TABLE
 383 ><P
 384 ></P
 385 ></DIV
 386 ><HR><DIV
 387 CLASS="REFSECT2"
 388 ><A
 389 NAME="AEN21572"
 390 ></A
 391 ><H3
 392 ><A
 393 NAME="DOCBSAXHANDLER"
 394 ></A
 395 >docbSAXHandler</H3
 396 ><TABLE
 397 BORDER="0"
 398 BGCOLOR="#D6E8FF"
 399 WIDTH="100%"
 400 CELLPADDING="6"
 401 ><TR
 402 ><TD
 403 ><PRE
 404 CLASS="PROGRAMLISTING"
 405 >typedef xmlSAXHandler docbSAXHandler;</PRE
 406 ></TD
 407 ></TR
 408 ></TABLE
 409 ><P
 410 ></P
 411 ></DIV
 412 ><HR><DIV
 413 CLASS="REFSECT2"
 414 ><A
 415 NAME="AEN21577"
 416 ></A
 417 ><H3
 418 ><A
 419 NAME="DOCBSAXHANDLERPTR"
 420 ></A
 421 >docbSAXHandlerPtr</H3
 422 ><TABLE
 423 BORDER="0"
 424 BGCOLOR="#D6E8FF"
 425 WIDTH="100%"
 426 CELLPADDING="6"
 427 ><TR
 428 ><TD
 429 ><PRE
 430 CLASS="PROGRAMLISTING"
 431 >typedef xmlSAXHandlerPtr docbSAXHandlerPtr;</PRE
 432 ></TD
 433 ></TR
 434 ></TABLE
 435 ><P
 436 ></P
 437 ></DIV
 438 ><HR><DIV
 439 CLASS="REFSECT2"
 440 ><A
 441 NAME="AEN21582"
 442 ></A
 443 ><H3
 444 ><A
 445 NAME="DOCBPARSERINPUT"
 446 ></A
 447 >docbParserInput</H3
 448 ><TABLE
 449 BORDER="0"
 450 BGCOLOR="#D6E8FF"
 451 WIDTH="100%"
 452 CELLPADDING="6"
 453 ><TR
 454 ><TD
 455 ><PRE
 456 CLASS="PROGRAMLISTING"
 457 >typedef xmlParserInput docbParserInput;</PRE
 458 ></TD
 459 ></TR
 460 ></TABLE
 461 ><P
 462 ></P
 463 ></DIV
 464 ><HR><DIV
 465 CLASS="REFSECT2"
 466 ><A
 467 NAME="AEN21587"
 468 ></A
 469 ><H3
 470 ><A
 471 NAME="DOCBPARSERINPUTPTR"
 472 ></A
 473 >docbParserInputPtr</H3
 474 ><TABLE
 475 BORDER="0"
 476 BGCOLOR="#D6E8FF"
 477 WIDTH="100%"
 478 CELLPADDING="6"
 479 ><TR
 480 ><TD
 481 ><PRE
 482 CLASS="PROGRAMLISTING"
 483 >typedef xmlParserInputPtr docbParserInputPtr;</PRE
 484 ></TD
 485 ></TR
 486 ></TABLE
 487 ><P
 488 ></P
 489 ></DIV
 490 ><HR><DIV
 491 CLASS="REFSECT2"
 492 ><A
 493 NAME="AEN21592"
 494 ></A
 495 ><H3
 496 ><A
 497 NAME="DOCBDOCPTR"
 498 ></A
 499 >docbDocPtr</H3
 500 ><TABLE
 501 BORDER="0"
 502 BGCOLOR="#D6E8FF"
 503 WIDTH="100%"
 504 CELLPADDING="6"
 505 ><TR
 506 ><TD
 507 ><PRE
 508 CLASS="PROGRAMLISTING"
 509 >typedef xmlDocPtr docbDocPtr;</PRE
 510 ></TD
 511 ></TR
 512 ></TABLE
 513 ><P
 514 ></P
 515 ></DIV
 516 ><HR><DIV
 517 CLASS="REFSECT2"
 518 ><A
 519 NAME="AEN21597"
 520 ></A
 521 ><H3
 522 ><A
 523 NAME="DOCBNODEPTR"
 524 ></A
 525 >docbNodePtr</H3
 526 ><TABLE
 527 BORDER="0"
 528 BGCOLOR="#D6E8FF"
 529 WIDTH="100%"
 530 CELLPADDING="6"
 531 ><TR
 532 ><TD
 533 ><PRE
 534 CLASS="PROGRAMLISTING"
 535 >typedef xmlNodePtr docbNodePtr;</PRE
 536 ></TD
 537 ></TR
 538 ></TABLE
 539 ><P
 540 ></P
 541 ></DIV
 542 ><HR><DIV
 543 CLASS="REFSECT2"
 544 ><A
 545 NAME="AEN21602"
 546 ></A
 547 ><H3
 548 ><A
 549 NAME="DOCBENCODEENTITIES"
 550 ></A
 551 >docbEncodeEntities ()</H3
 552 ><TABLE
 553 BORDER="0"
 554 BGCOLOR="#D6E8FF"
 555 WIDTH="100%"
 556 CELLPADDING="6"
 557 ><TR
 558 ><TD
 559 ><PRE
 560 CLASS="PROGRAMLISTING"
 561 >int         docbEncodeEntities              (unsigned char *out,
 562                                              int *outlen,
 563                                              unsigned char *in,
 564                                              int *inlen,
 565                                              int quoteChar);</PRE
 566 ></TD
 567 ></TR
 568 ></TABLE
 569 ><P
 570 >Take a block of UTF-8 chars in and try to convert it to an ASCII
 571 plus SGML entities block of chars out.</P
 572 ><P
 573 ></P
 574 ><DIV
 575 CLASS="INFORMALTABLE"
 576 ><A
 577 NAME="AEN21608"><P
 578 ></P
 579 ><TABLE
 580 BORDER="0"
 581 WIDTH="100%"
 582 BGCOLOR="#FFD0D0"
 583 CELLSPACING="0"
 584 CELLPADDING="4"
 585 CLASS="CALSTABLE"
 586 ><TBODY
 587 ><TR
 588 ><TD
 589 WIDTH="20%"
 590 ALIGN="RIGHT"
 591 VALIGN="TOP"
 592 ><TT
 593 CLASS="PARAMETER"
 594 ><I
 595 >out</I
 596 ></TT
 597 >&nbsp;:</TD
 598 ><TD
 599 WIDTH="80%"
 600 ALIGN="LEFT"
 601 VALIGN="TOP"
 602 >  a pointer to an array of bytes to store the result</TD
 603 ></TR
 604 ><TR
 605 ><TD
 606 WIDTH="20%"
 607 ALIGN="RIGHT"
 608 VALIGN="TOP"
 609 ><TT
 610 CLASS="PARAMETER"
 611 ><I
 612 >outlen</I
 613 ></TT
 614 >&nbsp;:</TD
 615 ><TD
 616 WIDTH="80%"
 617 ALIGN="LEFT"
 618 VALIGN="TOP"
 619 >  the length of <TT
 620 CLASS="PARAMETER"
 621 ><I
 622 >out</I
 623 ></TT
 624 ></TD
 625 ></TR
 626 ><TR
 627 ><TD
 628 WIDTH="20%"
 629 ALIGN="RIGHT"
 630 VALIGN="TOP"
 631 ><TT
 632 CLASS="PARAMETER"
 633 ><I
 634 >in</I
 635 ></TT
 636 >&nbsp;:</TD
 637 ><TD
 638 WIDTH="80%"
 639 ALIGN="LEFT"
 640 VALIGN="TOP"
 641 >  a pointer to an array of UTF-8 chars</TD
 642 ></TR
 643 ><TR
 644 ><TD
 645 WIDTH="20%"
 646 ALIGN="RIGHT"
 647 VALIGN="TOP"
 648 ><TT
 649 CLASS="PARAMETER"
 650 ><I
 651 >inlen</I
 652 ></TT
 653 >&nbsp;:</TD
 654 ><TD
 655 WIDTH="80%"
 656 ALIGN="LEFT"
 657 VALIGN="TOP"
 658 >  the length of <TT
 659 CLASS="PARAMETER"
 660 ><I
 661 >in</I
 662 ></TT
 663 ></TD
 664 ></TR
 665 ><TR
 666 ><TD
 667 WIDTH="20%"
 668 ALIGN="RIGHT"
 669 VALIGN="TOP"
 670 ><TT
 671 CLASS="PARAMETER"
 672 ><I
 673 >quoteChar</I
 674 ></TT
 675 >&nbsp;:</TD
 676 ><TD
 677 WIDTH="80%"
 678 ALIGN="LEFT"
 679 VALIGN="TOP"
 680 > the quote character to escape (' or ") or zero.</TD
 681 ></TR
 682 ><TR
 683 ><TD
 684 WIDTH="20%"
 685 ALIGN="RIGHT"
 686 VALIGN="TOP"
 687 ><SPAN
 688 CLASS="emphasis"
 689 ><I
 690 CLASS="EMPHASIS"
 691 >Returns</I
 692 ></SPAN
 693 > :</TD
 694 ><TD
 695 WIDTH="80%"
 696 ALIGN="LEFT"
 697 VALIGN="TOP"
 698 >0 if success, -2 if the transcoding fails, or -1 otherwise
 699 The value of <TT
 700 CLASS="PARAMETER"
 701 ><I
 702 >inlen</I
 703 ></TT
 704 > after return is the number of octets consumed
 705 as the return value is positive, else unpredictable.
 706 The value of <TT
 707 CLASS="PARAMETER"
 708 ><I
 709 >outlen</I
 710 ></TT
 711 > after return is the number of octets consumed.</TD
 712 ></TR
 713 ></TBODY
 714 ></TABLE
 715 ><P
 716 ></P
 717 ></DIV
 718 ></DIV
 719 ><HR><DIV
 720 CLASS="REFSECT2"
 721 ><A
 722 NAME="AEN21641"
 723 ></A
 724 ><H3
 725 ><A
 726 NAME="DOCBSAXPARSEDOC"
 727 ></A
 728 >docbSAXParseDoc ()</H3
 729 ><TABLE
 730 BORDER="0"
 731 BGCOLOR="#D6E8FF"
 732 WIDTH="100%"
 733 CELLPADDING="6"
 734 ><TR
 735 ><TD
 736 ><PRE
 737 CLASS="PROGRAMLISTING"
 738 ><A
 739 HREF="libxml-docbparser.html#DOCBDOCPTR"
 740 >docbDocPtr</A
 741 >  docbSAXParseDoc                 (<A
 742 HREF="libxml-tree.html#XMLCHAR"
 743 >xmlChar</A
 744 > *cur,
 745                                              const char *encoding,
 746                                              <A
 747 HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
 748 >docbSAXHandlerPtr</A
 749 > sax,
 750                                              void *userData);</PRE
 751 ></TD
 752 ></TR
 753 ></TABLE
 754 ><P
 755 >parse an SGML in-memory document and build a tree.
 756 It use the given SAX function block to handle the parsing callback.
 757 If sax is NULL, fallback to the default DOM tree building routines.</P
 758 ><P
 759 ></P
 760 ><DIV
 761 CLASS="INFORMALTABLE"
 762 ><A
 763 NAME="AEN21650"><P
 764 ></P
 765 ><TABLE
 766 BORDER="0"
 767 WIDTH="100%"
 768 BGCOLOR="#FFD0D0"
 769 CELLSPACING="0"
 770 CELLPADDING="4"
 771 CLASS="CALSTABLE"
 772 ><TBODY
 773 ><TR
 774 ><TD
 775 WIDTH="20%"
 776 ALIGN="RIGHT"
 777 VALIGN="TOP"
 778 ><TT
 779 CLASS="PARAMETER"
 780 ><I
 781 >cur</I
 782 ></TT
 783 >&nbsp;:</TD
 784 ><TD
 785 WIDTH="80%"
 786 ALIGN="LEFT"
 787 VALIGN="TOP"
 788 >  a pointer to an array of xmlChar</TD
 789 ></TR
 790 ><TR
 791 ><TD
 792 WIDTH="20%"
 793 ALIGN="RIGHT"
 794 VALIGN="TOP"
 795 ><TT
 796 CLASS="PARAMETER"
 797 ><I
 798 >encoding</I
 799 ></TT
 800 >&nbsp;:</TD
 801 ><TD
 802 WIDTH="80%"
 803 ALIGN="LEFT"
 804 VALIGN="TOP"
 805 >  a free form C string describing the SGML document encoding, or NULL</TD
 806 ></TR
 807 ><TR
 808 ><TD
 809 WIDTH="20%"
 810 ALIGN="RIGHT"
 811 VALIGN="TOP"
 812 ><TT
 813 CLASS="PARAMETER"
 814 ><I
 815 >sax</I
 816 ></TT
 817 >&nbsp;:</TD
 818 ><TD
 819 WIDTH="80%"
 820 ALIGN="LEFT"
 821 VALIGN="TOP"
 822 >  the SAX handler block</TD
 823 ></TR
 824 ><TR
 825 ><TD
 826 WIDTH="20%"
 827 ALIGN="RIGHT"
 828 VALIGN="TOP"
 829 ><TT
 830 CLASS="PARAMETER"
 831 ><I
 832 >userData</I
 833 ></TT
 834 >&nbsp;:</TD
 835 ><TD
 836 WIDTH="80%"
 837 ALIGN="LEFT"
 838 VALIGN="TOP"
 839 > if using SAX, this pointer will be provided on callbacks. </TD
 840 ></TR
 841 ><TR
 842 ><TD
 843 WIDTH="20%"
 844 ALIGN="RIGHT"
 845 VALIGN="TOP"
 846 ><SPAN
 847 CLASS="emphasis"
 848 ><I
 849 CLASS="EMPHASIS"
 850 >Returns</I
 851 ></SPAN
 852 > :</TD
 853 ><TD
 854 WIDTH="80%"
 855 ALIGN="LEFT"
 856 VALIGN="TOP"
 857 >the resulting document tree</TD
 858 ></TR
 859 ></TBODY
 860 ></TABLE
 861 ><P
 862 ></P
 863 ></DIV
 864 ></DIV
 865 ><HR><DIV
 866 CLASS="REFSECT2"
 867 ><A
 868 NAME="AEN21675"
 869 ></A
 870 ><H3
 871 ><A
 872 NAME="DOCBPARSEDOC"
 873 ></A
 874 >docbParseDoc ()</H3
 875 ><TABLE
 876 BORDER="0"
 877 BGCOLOR="#D6E8FF"
 878 WIDTH="100%"
 879 CELLPADDING="6"
 880 ><TR
 881 ><TD
 882 ><PRE
 883 CLASS="PROGRAMLISTING"
 884 ><A
 885 HREF="libxml-docbparser.html#DOCBDOCPTR"
 886 >docbDocPtr</A
 887 >  docbParseDoc                    (<A
 888 HREF="libxml-tree.html#XMLCHAR"
 889 >xmlChar</A
 890 > *cur,
 891                                              const char *encoding);</PRE
 892 ></TD
 893 ></TR
 894 ></TABLE
 895 ><P
 896 >parse an SGML in-memory document and build a tree.</P
 897 ><P
 898 ></P
 899 ><DIV
 900 CLASS="INFORMALTABLE"
 901 ><A
 902 NAME="AEN21683"><P
 903 ></P
 904 ><TABLE
 905 BORDER="0"
 906 WIDTH="100%"
 907 BGCOLOR="#FFD0D0"
 908 CELLSPACING="0"
 909 CELLPADDING="4"
 910 CLASS="CALSTABLE"
 911 ><TBODY
 912 ><TR
 913 ><TD
 914 WIDTH="20%"
 915 ALIGN="RIGHT"
 916 VALIGN="TOP"
 917 ><TT
 918 CLASS="PARAMETER"
 919 ><I
 920 >cur</I
 921 ></TT
 922 >&nbsp;:</TD
 923 ><TD
 924 WIDTH="80%"
 925 ALIGN="LEFT"
 926 VALIGN="TOP"
 927 >  a pointer to an array of xmlChar</TD
 928 ></TR
 929 ><TR
 930 ><TD
 931 WIDTH="20%"
 932 ALIGN="RIGHT"
 933 VALIGN="TOP"
 934 ><TT
 935 CLASS="PARAMETER"
 936 ><I
 937 >encoding</I
 938 ></TT
 939 >&nbsp;:</TD
 940 ><TD
 941 WIDTH="80%"
 942 ALIGN="LEFT"
 943 VALIGN="TOP"
 944 >  a free form C string describing the SGML document encoding, or NULL</TD
 945 ></TR
 946 ><TR
 947 ><TD
 948 WIDTH="20%"
 949 ALIGN="RIGHT"
 950 VALIGN="TOP"
 951 ><SPAN
 952 CLASS="emphasis"
 953 ><I
 954 CLASS="EMPHASIS"
 955 >Returns</I
 956 ></SPAN
 957 > :</TD
 958 ><TD
 959 WIDTH="80%"
 960 ALIGN="LEFT"
 961 VALIGN="TOP"
 962 >the resulting document tree</TD
 963 ></TR
 964 ></TBODY
 965 ></TABLE
 966 ><P
 967 ></P
 968 ></DIV
 969 ></DIV
 970 ><HR><DIV
 971 CLASS="REFSECT2"
 972 ><A
 973 NAME="AEN21700"
 974 ></A
 975 ><H3
 976 ><A
 977 NAME="DOCBSAXPARSEFILE"
 978 ></A
 979 >docbSAXParseFile ()</H3
 980 ><TABLE
 981 BORDER="0"
 982 BGCOLOR="#D6E8FF"
 983 WIDTH="100%"
 984 CELLPADDING="6"
 985 ><TR
 986 ><TD
 987 ><PRE
 988 CLASS="PROGRAMLISTING"
 989 ><A
 990 HREF="libxml-docbparser.html#DOCBDOCPTR"
 991 >docbDocPtr</A
 992 >  docbSAXParseFile                (const char *filename,
 993                                              const char *encoding,
 994                                              <A
 995 HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
 996 >docbSAXHandlerPtr</A
 997 > sax,
 998                                              void *userData);</PRE
 999 ></TD
1000 ></TR
1001 ></TABLE
1002 ><P
1003 >parse an SGML file and build a tree. Automatic support for ZLIB/Compress
1004 compressed document is provided by default if found at compile-time.
1005 It use the given SAX function block to handle the parsing callback.
1006 If sax is NULL, fallback to the default DOM tree building routines.</P
1007 ><P
1008 ></P
1009 ><DIV
1010 CLASS="INFORMALTABLE"
1011 ><A
1012 NAME="AEN21708"><P
1013 ></P
1014 ><TABLE
1015 BORDER="0"
1016 WIDTH="100%"
1017 BGCOLOR="#FFD0D0"
1018 CELLSPACING="0"
1019 CELLPADDING="4"
1020 CLASS="CALSTABLE"
1021 ><TBODY
1022 ><TR
1023 ><TD
1024 WIDTH="20%"
1025 ALIGN="RIGHT"
1026 VALIGN="TOP"
1027 ><TT
1028 CLASS="PARAMETER"
1029 ><I
1030 >filename</I
1031 ></TT
1032 >&nbsp;:</TD
1033 ><TD
1034 WIDTH="80%"
1035 ALIGN="LEFT"
1036 VALIGN="TOP"
1037 >  the filename</TD
1038 ></TR
1039 ><TR
1040 ><TD
1041 WIDTH="20%"
1042 ALIGN="RIGHT"
1043 VALIGN="TOP"
1044 ><TT
1045 CLASS="PARAMETER"
1046 ><I
1047 >encoding</I
1048 ></TT
1049 >&nbsp;:</TD
1050 ><TD
1051 WIDTH="80%"
1052 ALIGN="LEFT"
1053 VALIGN="TOP"
1054 >  a free form C string describing the SGML document encoding, or NULL</TD
1055 ></TR
1056 ><TR
1057 ><TD
1058 WIDTH="20%"
1059 ALIGN="RIGHT"
1060 VALIGN="TOP"
1061 ><TT
1062 CLASS="PARAMETER"
1063 ><I
1064 >sax</I
1065 ></TT
1066 >&nbsp;:</TD
1067 ><TD
1068 WIDTH="80%"
1069 ALIGN="LEFT"
1070 VALIGN="TOP"
1071 >  the SAX handler block</TD
1072 ></TR
1073 ><TR
1074 ><TD
1075 WIDTH="20%"
1076 ALIGN="RIGHT"
1077 VALIGN="TOP"
1078 ><TT
1079 CLASS="PARAMETER"
1080 ><I
1081 >userData</I
1082 ></TT
1083 >&nbsp;:</TD
1084 ><TD
1085 WIDTH="80%"
1086 ALIGN="LEFT"
1087 VALIGN="TOP"
1088 > if using SAX, this pointer will be provided on callbacks. </TD
1089 ></TR
1090 ><TR
1091 ><TD
1092 WIDTH="20%"
1093 ALIGN="RIGHT"
1094 VALIGN="TOP"
1095 ><SPAN
1096 CLASS="emphasis"
1097 ><I
1098 CLASS="EMPHASIS"
1099 >Returns</I
1100 ></SPAN
1101 > :</TD
1102 ><TD
1103 WIDTH="80%"
1104 ALIGN="LEFT"
1105 VALIGN="TOP"
1106 >the resulting document tree</TD
1107 ></TR
1108 ></TBODY
1109 ></TABLE
1110 ><P
1111 ></P
1112 ></DIV
1113 ></DIV
1114 ><HR><DIV
1115 CLASS="REFSECT2"
1116 ><A
1117 NAME="AEN21733"
1118 ></A
1119 ><H3
1120 ><A
1121 NAME="DOCBPARSEFILE"
1122 ></A
1123 >docbParseFile ()</H3
1124 ><TABLE
1125 BORDER="0"
1126 BGCOLOR="#D6E8FF"
1127 WIDTH="100%"
1128 CELLPADDING="6"
1129 ><TR
1130 ><TD
1131 ><PRE
1132 CLASS="PROGRAMLISTING"
1133 ><A
1134 HREF="libxml-docbparser.html#DOCBDOCPTR"
1135 >docbDocPtr</A
1136 >  docbParseFile                   (const char *filename,
1137                                              const char *encoding);</PRE
1138 ></TD
1139 ></TR
1140 ></TABLE
1141 ><P
1142 >parse a Docbook SGML file and build a tree. Automatic support for
1143 ZLIB/Compress compressed document is provided by default if found
1144 at compile-time.</P
1145 ><P
1146 ></P
1147 ><DIV
1148 CLASS="INFORMALTABLE"
1149 ><A
1150 NAME="AEN21740"><P
1151 ></P
1152 ><TABLE
1153 BORDER="0"
1154 WIDTH="100%"
1155 BGCOLOR="#FFD0D0"
1156 CELLSPACING="0"
1157 CELLPADDING="4"
1158 CLASS="CALSTABLE"
1159 ><TBODY
1160 ><TR
1161 ><TD
1162 WIDTH="20%"
1163 ALIGN="RIGHT"
1164 VALIGN="TOP"
1165 ><TT
1166 CLASS="PARAMETER"
1167 ><I
1168 >filename</I
1169 ></TT
1170 >&nbsp;:</TD
1171 ><TD
1172 WIDTH="80%"
1173 ALIGN="LEFT"
1174 VALIGN="TOP"
1175 >  the filename</TD
1176 ></TR
1177 ><TR
1178 ><TD
1179 WIDTH="20%"
1180 ALIGN="RIGHT"
1181 VALIGN="TOP"
1182 ><TT
1183 CLASS="PARAMETER"
1184 ><I
1185 >encoding</I
1186 ></TT
1187 >&nbsp;:</TD
1188 ><TD
1189 WIDTH="80%"
1190 ALIGN="LEFT"
1191 VALIGN="TOP"
1192 >  a free form C string describing document encoding, or NULL</TD
1193 ></TR
1194 ><TR
1195 ><TD
1196 WIDTH="20%"
1197 ALIGN="RIGHT"
1198 VALIGN="TOP"
1199 ><SPAN
1200 CLASS="emphasis"
1201 ><I
1202 CLASS="EMPHASIS"
1203 >Returns</I
1204 ></SPAN
1205 > :</TD
1206 ><TD
1207 WIDTH="80%"
1208 ALIGN="LEFT"
1209 VALIGN="TOP"
1210 >the resulting document tree</TD
1211 ></TR
1212 ></TBODY
1213 ></TABLE
1214 ><P
1215 ></P
1216 ></DIV
1217 ></DIV
1218 ><HR><DIV
1219 CLASS="REFSECT2"
1220 ><A
1221 NAME="AEN21757"
1222 ></A
1223 ><H3
1224 ><A
1225 NAME="DOCBFREEPARSERCTXT"
1226 ></A
1227 >docbFreeParserCtxt ()</H3
1228 ><TABLE
1229 BORDER="0"
1230 BGCOLOR="#D6E8FF"
1231 WIDTH="100%"
1232 CELLPADDING="6"
1233 ><TR
1234 ><TD
1235 ><PRE
1236 CLASS="PROGRAMLISTING"
1237 >void        docbFreeParserCtxt              (<A
1238 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1239 >docbParserCtxtPtr</A
1240 > ctxt);</PRE
1241 ></TD
1242 ></TR
1243 ></TABLE
1244 ><P
1245 >Free all the memory used by a parser context. However the parsed
1246 document in ctxt-&gt;myDoc is not freed.</P
1247 ><P
1248 ></P
1249 ><DIV
1250 CLASS="INFORMALTABLE"
1251 ><A
1252 NAME="AEN21764"><P
1253 ></P
1254 ><TABLE
1255 BORDER="0"
1256 WIDTH="100%"
1257 BGCOLOR="#FFD0D0"
1258 CELLSPACING="0"
1259 CELLPADDING="4"
1260 CLASS="CALSTABLE"
1261 ><TBODY
1262 ><TR
1263 ><TD
1264 WIDTH="20%"
1265 ALIGN="RIGHT"
1266 VALIGN="TOP"
1267 ><TT
1268 CLASS="PARAMETER"
1269 ><I
1270 >ctxt</I
1271 ></TT
1272 >&nbsp;:</TD
1273 ><TD
1274 WIDTH="80%"
1275 ALIGN="LEFT"
1276 VALIGN="TOP"
1277 >  an SGML parser context</TD
1278 ></TR
1279 ></TBODY
1280 ></TABLE
1281 ><P
1282 ></P
1283 ></DIV
1284 ></DIV
1285 ><HR><DIV
1286 CLASS="REFSECT2"
1287 ><A
1288 NAME="AEN21773"
1289 ></A
1290 ><H3
1291 ><A
1292 NAME="DOCBCREATEPUSHPARSERCTXT"
1293 ></A
1294 >docbCreatePushParserCtxt ()</H3
1295 ><TABLE
1296 BORDER="0"
1297 BGCOLOR="#D6E8FF"
1298 WIDTH="100%"
1299 CELLPADDING="6"
1300 ><TR
1301 ><TD
1302 ><PRE
1303 CLASS="PROGRAMLISTING"
1304 ><A
1305 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1306 >docbParserCtxtPtr</A
1307 > docbCreatePushParserCtxt  (<A
1308 HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
1309 >docbSAXHandlerPtr</A
1310 > sax,
1311                                              void *user_data,
1312                                              const char *chunk,
1313                                              int size,
1314                                              const char *filename,
1315                                              <A
1316 HREF="libxml-encoding.html#XMLCHARENCODING"
1317 >xmlCharEncoding</A
1318 > enc);</PRE
1319 ></TD
1320 ></TR
1321 ></TABLE
1322 ><P
1323 >Create a parser context for using the DocBook SGML parser in push mode
1324 To allow content encoding detection, <TT
1325 CLASS="PARAMETER"
1326 ><I
1327 >size</I
1328 ></TT
1329 > should be &gt;= 4
1330 The value of <TT
1331 CLASS="PARAMETER"
1332 ><I
1333 >filename</I
1334 ></TT
1335 > is used for fetching external entities
1336 and error/warning reports.</P
1337 ><P
1338 ></P
1339 ><DIV
1340 CLASS="INFORMALTABLE"
1341 ><A
1342 NAME="AEN21784"><P
1343 ></P
1344 ><TABLE
1345 BORDER="0"
1346 WIDTH="100%"
1347 BGCOLOR="#FFD0D0"
1348 CELLSPACING="0"
1349 CELLPADDING="4"
1350 CLASS="CALSTABLE"
1351 ><TBODY
1352 ><TR
1353 ><TD
1354 WIDTH="20%"
1355 ALIGN="RIGHT"
1356 VALIGN="TOP"
1357 ><TT
1358 CLASS="PARAMETER"
1359 ><I
1360 >sax</I
1361 ></TT
1362 >&nbsp;:</TD
1363 ><TD
1364 WIDTH="80%"
1365 ALIGN="LEFT"
1366 VALIGN="TOP"
1367 >  a SAX handler</TD
1368 ></TR
1369 ><TR
1370 ><TD
1371 WIDTH="20%"
1372 ALIGN="RIGHT"
1373 VALIGN="TOP"
1374 ><TT
1375 CLASS="PARAMETER"
1376 ><I
1377 >user_data</I
1378 ></TT
1379 >&nbsp;:</TD
1380 ><TD
1381 WIDTH="80%"
1382 ALIGN="LEFT"
1383 VALIGN="TOP"
1384 >  The user data returned on SAX callbacks</TD
1385 ></TR
1386 ><TR
1387 ><TD
1388 WIDTH="20%"
1389 ALIGN="RIGHT"
1390 VALIGN="TOP"
1391 ><TT
1392 CLASS="PARAMETER"
1393 ><I
1394 >chunk</I
1395 ></TT
1396 >&nbsp;:</TD
1397 ><TD
1398 WIDTH="80%"
1399 ALIGN="LEFT"
1400 VALIGN="TOP"
1401 >  a pointer to an array of chars</TD
1402 ></TR
1403 ><TR
1404 ><TD
1405 WIDTH="20%"
1406 ALIGN="RIGHT"
1407 VALIGN="TOP"
1408 ><TT
1409 CLASS="PARAMETER"
1410 ><I
1411 >size</I
1412 ></TT
1413 >&nbsp;:</TD
1414 ><TD
1415 WIDTH="80%"
1416 ALIGN="LEFT"
1417 VALIGN="TOP"
1418 >  number of chars in the array</TD
1419 ></TR
1420 ><TR
1421 ><TD
1422 WIDTH="20%"
1423 ALIGN="RIGHT"
1424 VALIGN="TOP"
1425 ><TT
1426 CLASS="PARAMETER"
1427 ><I
1428 >filename</I
1429 ></TT
1430 >&nbsp;:</TD
1431 ><TD
1432 WIDTH="80%"
1433 ALIGN="LEFT"
1434 VALIGN="TOP"
1435 >  an optional file name or URI</TD
1436 ></TR
1437 ><TR
1438 ><TD
1439 WIDTH="20%"
1440 ALIGN="RIGHT"
1441 VALIGN="TOP"
1442 ><TT
1443 CLASS="PARAMETER"
1444 ><I
1445 >enc</I
1446 ></TT
1447 >&nbsp;:</TD
1448 ><TD
1449 WIDTH="80%"
1450 ALIGN="LEFT"
1451 VALIGN="TOP"
1452 >  an optional encoding</TD
1453 ></TR
1454 ><TR
1455 ><TD
1456 WIDTH="20%"
1457 ALIGN="RIGHT"
1458 VALIGN="TOP"
1459 ><SPAN
1460 CLASS="emphasis"
1461 ><I
1462 CLASS="EMPHASIS"
1463 >Returns</I
1464 ></SPAN
1465 > :</TD
1466 ><TD
1467 WIDTH="80%"
1468 ALIGN="LEFT"
1469 VALIGN="TOP"
1470 >the new parser context or NULL</TD
1471 ></TR
1472 ></TBODY
1473 ></TABLE
1474 ><P
1475 ></P
1476 ></DIV
1477 ></DIV
1478 ><HR><DIV
1479 CLASS="REFSECT2"
1480 ><A
1481 NAME="AEN21817"
1482 ></A
1483 ><H3
1484 ><A
1485 NAME="DOCBPARSECHUNK"
1486 ></A
1487 >docbParseChunk ()</H3
1488 ><TABLE
1489 BORDER="0"
1490 BGCOLOR="#D6E8FF"
1491 WIDTH="100%"
1492 CELLPADDING="6"
1493 ><TR
1494 ><TD
1495 ><PRE
1496 CLASS="PROGRAMLISTING"
1497 >int         docbParseChunk                  (<A
1498 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1499 >docbParserCtxtPtr</A
1500 > ctxt,
1501                                              const char *chunk,
1502                                              int size,
1503                                              int terminate);</PRE
1504 ></TD
1505 ></TR
1506 ></TABLE
1507 ><P
1508 >Parse a Chunk of memory</P
1509 ><P
1510 ></P
1511 ><DIV
1512 CLASS="INFORMALTABLE"
1513 ><A
1514 NAME="AEN21824"><P
1515 ></P
1516 ><TABLE
1517 BORDER="0"
1518 WIDTH="100%"
1519 BGCOLOR="#FFD0D0"
1520 CELLSPACING="0"
1521 CELLPADDING="4"
1522 CLASS="CALSTABLE"
1523 ><TBODY
1524 ><TR
1525 ><TD
1526 WIDTH="20%"
1527 ALIGN="RIGHT"
1528 VALIGN="TOP"
1529 ><TT
1530 CLASS="PARAMETER"
1531 ><I
1532 >ctxt</I
1533 ></TT
1534 >&nbsp;:</TD
1535 ><TD
1536 WIDTH="80%"
1537 ALIGN="LEFT"
1538 VALIGN="TOP"
1539 >  an XML parser context</TD
1540 ></TR
1541 ><TR
1542 ><TD
1543 WIDTH="20%"
1544 ALIGN="RIGHT"
1545 VALIGN="TOP"
1546 ><TT
1547 CLASS="PARAMETER"
1548 ><I
1549 >chunk</I
1550 ></TT
1551 >&nbsp;:</TD
1552 ><TD
1553 WIDTH="80%"
1554 ALIGN="LEFT"
1555 VALIGN="TOP"
1556 >  an char array</TD
1557 ></TR
1558 ><TR
1559 ><TD
1560 WIDTH="20%"
1561 ALIGN="RIGHT"
1562 VALIGN="TOP"
1563 ><TT
1564 CLASS="PARAMETER"
1565 ><I
1566 >size</I
1567 ></TT
1568 >&nbsp;:</TD
1569 ><TD
1570 WIDTH="80%"
1571 ALIGN="LEFT"
1572 VALIGN="TOP"
1573 >  the size in byte of the chunk</TD
1574 ></TR
1575 ><TR
1576 ><TD
1577 WIDTH="20%"
1578 ALIGN="RIGHT"
1579 VALIGN="TOP"
1580 ><TT
1581 CLASS="PARAMETER"
1582 ><I
1583 >terminate</I
1584 ></TT
1585 >&nbsp;:</TD
1586 ><TD
1587 WIDTH="80%"
1588 ALIGN="LEFT"
1589 VALIGN="TOP"
1590 >  last chunk indicator</TD
1591 ></TR
1592 ><TR
1593 ><TD
1594 WIDTH="20%"
1595 ALIGN="RIGHT"
1596 VALIGN="TOP"
1597 ><SPAN
1598 CLASS="emphasis"
1599 ><I
1600 CLASS="EMPHASIS"
1601 >Returns</I
1602 ></SPAN
1603 > :</TD
1604 ><TD
1605 WIDTH="80%"
1606 ALIGN="LEFT"
1607 VALIGN="TOP"
1608 >zero if no error, the xmlParserErrors otherwise.</TD
1609 ></TR
1610 ></TBODY
1611 ></TABLE
1612 ><P
1613 ></P
1614 ></DIV
1615 ></DIV
1616 ><HR><DIV
1617 CLASS="REFSECT2"
1618 ><A
1619 NAME="AEN21849"
1620 ></A
1621 ><H3
1622 ><A
1623 NAME="DOCBCREATEFILEPARSERCTXT"
1624 ></A
1625 >docbCreateFileParserCtxt ()</H3
1626 ><TABLE
1627 BORDER="0"
1628 BGCOLOR="#D6E8FF"
1629 WIDTH="100%"
1630 CELLPADDING="6"
1631 ><TR
1632 ><TD
1633 ><PRE
1634 CLASS="PROGRAMLISTING"
1635 ><A
1636 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1637 >docbParserCtxtPtr</A
1638 > docbCreateFileParserCtxt  (const char *filename,
1639                                              const char *encoding);</PRE
1640 ></TD
1641 ></TR
1642 ></TABLE
1643 ><P
1644 >Create a parser context for a file content.
1645 Automatic support for ZLIB/Compress compressed document is provided
1646 by default if found at compile-time.</P
1647 ><P
1648 ></P
1649 ><DIV
1650 CLASS="INFORMALTABLE"
1651 ><A
1652 NAME="AEN21856"><P
1653 ></P
1654 ><TABLE
1655 BORDER="0"
1656 WIDTH="100%"
1657 BGCOLOR="#FFD0D0"
1658 CELLSPACING="0"
1659 CELLPADDING="4"
1660 CLASS="CALSTABLE"
1661 ><TBODY
1662 ><TR
1663 ><TD
1664 WIDTH="20%"
1665 ALIGN="RIGHT"
1666 VALIGN="TOP"
1667 ><TT
1668 CLASS="PARAMETER"
1669 ><I
1670 >filename</I
1671 ></TT
1672 >&nbsp;:</TD
1673 ><TD
1674 WIDTH="80%"
1675 ALIGN="LEFT"
1676 VALIGN="TOP"
1677 >  the filename</TD
1678 ></TR
1679 ><TR
1680 ><TD
1681 WIDTH="20%"
1682 ALIGN="RIGHT"
1683 VALIGN="TOP"
1684 ><TT
1685 CLASS="PARAMETER"
1686 ><I
1687 >encoding</I
1688 ></TT
1689 >&nbsp;:</TD
1690 ><TD
1691 WIDTH="80%"
1692 ALIGN="LEFT"
1693 VALIGN="TOP"
1694 >  the SGML document encoding, or NULL</TD
1695 ></TR
1696 ><TR
1697 ><TD
1698 WIDTH="20%"
1699 ALIGN="RIGHT"
1700 VALIGN="TOP"
1701 ><SPAN
1702 CLASS="emphasis"
1703 ><I
1704 CLASS="EMPHASIS"
1705 >Returns</I
1706 ></SPAN
1707 > :</TD
1708 ><TD
1709 WIDTH="80%"
1710 ALIGN="LEFT"
1711 VALIGN="TOP"
1712 >the new parser context or NULL</TD
1713 ></TR
1714 ></TBODY
1715 ></TABLE
1716 ><P
1717 ></P
1718 ></DIV
1719 ></DIV
1720 ><HR><DIV
1721 CLASS="REFSECT2"
1722 ><A
1723 NAME="AEN21873"
1724 ></A
1725 ><H3
1726 ><A
1727 NAME="DOCBPARSEDOCUMENT"
1728 ></A
1729 >docbParseDocument ()</H3
1730 ><TABLE
1731 BORDER="0"
1732 BGCOLOR="#D6E8FF"
1733 WIDTH="100%"
1734 CELLPADDING="6"
1735 ><TR
1736 ><TD
1737 ><PRE
1738 CLASS="PROGRAMLISTING"
1739 >int         docbParseDocument               (<A
1740 HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1741 >docbParserCtxtPtr</A
1742 > ctxt);</PRE
1743 ></TD
1744 ></TR
1745 ></TABLE
1746 ><P
1747 >parse an SGML document (and build a tree if using the standard SAX
1748 interface).</P
1749 ><P
1750 ></P
1751 ><DIV
1752 CLASS="INFORMALTABLE"
1753 ><A
1754 NAME="AEN21880"><P
1755 ></P
1756 ><TABLE
1757 BORDER="0"
1758 WIDTH="100%"
1759 BGCOLOR="#FFD0D0"
1760 CELLSPACING="0"
1761 CELLPADDING="4"
1762 CLASS="CALSTABLE"
1763 ><TBODY
1764 ><TR
1765 ><TD
1766 WIDTH="20%"
1767 ALIGN="RIGHT"
1768 VALIGN="TOP"
1769 ><TT
1770 CLASS="PARAMETER"
1771 ><I
1772 >ctxt</I
1773 ></TT
1774 >&nbsp;:</TD
1775 ><TD
1776 WIDTH="80%"
1777 ALIGN="LEFT"
1778 VALIGN="TOP"
1779 >  an SGML parser context</TD
1780 ></TR
1781 ><TR
1782 ><TD
1783 WIDTH="20%"
1784 ALIGN="RIGHT"
1785 VALIGN="TOP"
1786 ><SPAN
1787 CLASS="emphasis"
1788 ><I
1789 CLASS="EMPHASIS"
1790 >Returns</I
1791 ></SPAN
1792 > :</TD
1793 ><TD
1794 WIDTH="80%"
1795 ALIGN="LEFT"
1796 VALIGN="TOP"
1797 >0, -1 in case of error. the parser context is augmented
1798 as a result of the parsing.</TD
1799 ></TR
1800 ></TBODY
1801 ></TABLE
1802 ><P
1803 ></P
1804 ></DIV
1805 ></DIV
1806 ></DIV
1807 ><DIV
1808 CLASS="NAVFOOTER"
1809 ><BR
1810 CLEAR="all"><BR><TABLE
1811 WIDTH="100%"
1812 BORDER="0"
1813 BGCOLOR="#000000"
1814 CELLPADDING="1"
1815 CELLSPACING="0"
1816 ><TR
1817 ><TD
1818 WIDTH="25%"
1819 BGCOLOR="#C00000"
1820 ALIGN="left"
1821 ><A
1822 HREF="libxml-globals.html"
1823 ><FONT
1824 COLOR="#FFFFFF"
1825 SIZE="3"
1826 ><B
1827 >&#60;&#60;&#60; Previous Page</B
1828 ></FONT
1829 ></A
1830 ></TD
1831 ><TD
1832 WIDTH="25%"
1833 BGCOLOR="#0000C0"
1834 ALIGN="center"
1835 ><FONT
1836 COLOR="#FFFFFF"
1837 SIZE="3"
1838 ><B
1839 ><A
1840 HREF="book1.html"
1841 ><FONT
1842 COLOR="#FFFFFF"
1843 SIZE="3"
1844 ><B
1845 >Home</B
1846 ></FONT
1847 ></A
1848 ></B
1849 ></FONT
1850 ></TD
1851 ><TD
1852 WIDTH="25%"
1853 BGCOLOR="#00C000"
1854 ALIGN="center"
1855 ><FONT
1856 COLOR="#FFFFFF"
1857 SIZE="3"
1858 ><B
1859 ><A
1860 HREF="libxml-lib.html"
1861 ><FONT
1862 COLOR="#FFFFFF"
1863 SIZE="3"
1864 ><B
1865 >Up</B
1866 ></FONT
1867 ></A
1868 ></B
1869 ></FONT
1870 ></TD
1871 ><TD
1872 WIDTH="25%"
1873 BGCOLOR="#C00000"
1874 ALIGN="right"
1875 ><A
1876 HREF="libxml-parserinternals.html"
1877 ><FONT
1878 COLOR="#FFFFFF"
1879 SIZE="3"
1880 ><B
1881 >Next Page &#62;&#62;&#62;</B
1882 ></FONT
1883 ></A
1884 ></TD
1885 ></TR
1886 ><TR
1887 ><TD
1888 COLSPAN="2"
1889 ALIGN="left"
1890 ><FONT
1891 COLOR="#FFFFFF"
1892 SIZE="3"
1893 ><B
1894 >globals</B
1895 ></FONT
1896 ></TD
1897 ><TD
1898 COLSPAN="2"
1899 ALIGN="right"
1900 ><FONT
1901 COLOR="#FFFFFF"
1902 SIZE="3"
1903 ><B
1904 >parserInternals</B
1905 ></FONT
1906 ></TD
1907 ></TR
1908 ></TABLE
1909 ></DIV
1910 ></BODY
1911 ></HTML
1912 >