libxml2/doc/html/libxml-c14n.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >c14n</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="catalog"
  17 HREF="libxml-catalog.html"><LINK
  18 REL="NEXT"
  19 TITLE="threads"
  20 HREF="libxml-threads.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-catalog.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-threads.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-C14N">c14n</H1
 121 ><DIV
 122 CLASS="REFNAMEDIV"
 123 ><A
 124 NAME="AEN20734"
 125 ></A
 126 ><H2
 127 >Name</H2
 128 >c14n&nbsp;--&nbsp;</DIV
 129 ><DIV
 130 CLASS="REFSYNOPSISDIV"
 131 ><A
 132 NAME="AEN20737"><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 int         <A
 146 HREF="libxml-c14n.html#XMLC14NDOCSAVETO"
 147 >xmlC14NDocSaveTo</A
 148 >                (<A
 149 HREF="libxml-tree.html#XMLDOCPTR"
 150 >xmlDocPtr</A
 151 > doc,
 152                                              <A
 153 HREF="libxml-xpath.html#XMLNODESETPTR"
 154 >xmlNodeSetPtr</A
 155 > nodes,
 156                                              int exclusive,
 157                                              <A
 158 HREF="libxml-tree.html#XMLCHAR"
 159 >xmlChar</A
 160 > **inclusive_ns_prefixes,
 161                                              int with_comments,
 162                                              <A
 163 HREF="libxml-tree.html#XMLOUTPUTBUFFERPTR"
 164 >xmlOutputBufferPtr</A
 165 > buf);
 166 int         <A
 167 HREF="libxml-c14n.html#XMLC14NDOCDUMPMEMORY"
 168 >xmlC14NDocDumpMemory</A
 169 >            (<A
 170 HREF="libxml-tree.html#XMLDOCPTR"
 171 >xmlDocPtr</A
 172 > doc,
 173                                              <A
 174 HREF="libxml-xpath.html#XMLNODESETPTR"
 175 >xmlNodeSetPtr</A
 176 > nodes,
 177                                              int exclusive,
 178                                              <A
 179 HREF="libxml-tree.html#XMLCHAR"
 180 >xmlChar</A
 181 > **inclusive_ns_prefixes,
 182                                              int with_comments,
 183                                              <A
 184 HREF="libxml-tree.html#XMLCHAR"
 185 >xmlChar</A
 186 > **doc_txt_ptr);
 187 int         <A
 188 HREF="libxml-c14n.html#XMLC14NDOCSAVE"
 189 >xmlC14NDocSave</A
 190 >                  (<A
 191 HREF="libxml-tree.html#XMLDOCPTR"
 192 >xmlDocPtr</A
 193 > doc,
 194                                              <A
 195 HREF="libxml-xpath.html#XMLNODESETPTR"
 196 >xmlNodeSetPtr</A
 197 > nodes,
 198                                              int exclusive,
 199                                              <A
 200 HREF="libxml-tree.html#XMLCHAR"
 201 >xmlChar</A
 202 > **inclusive_ns_prefixes,
 203                                              int with_comments,
 204                                              const char *filename,
 205                                              int compression);
 206 int         (<A
 207 HREF="libxml-c14n.html#XMLC14NISVISIBLECALLBACK"
 208 >*xmlC14NIsVisibleCallback</A
 209 >)     (void *user_data,
 210                                              <A
 211 HREF="libxml-tree.html#XMLNODEPTR"
 212 >xmlNodePtr</A
 213 > node,
 214                                              <A
 215 HREF="libxml-tree.html#XMLNODEPTR"
 216 >xmlNodePtr</A
 217 > parent);
 218 int         <A
 219 HREF="libxml-c14n.html#XMLC14NEXECUTE"
 220 >xmlC14NExecute</A
 221 >                  (<A
 222 HREF="libxml-tree.html#XMLDOCPTR"
 223 >xmlDocPtr</A
 224 > doc,
 225                                              <A
 226 HREF="libxml-c14n.html#XMLC14NISVISIBLECALLBACK"
 227 >xmlC14NIsVisibleCallback</A
 228 > is_visible_callback,
 229                                              void *user_data,
 230                                              int exclusive,
 231                                              <A
 232 HREF="libxml-tree.html#XMLCHAR"
 233 >xmlChar</A
 234 > **inclusive_ns_prefixes,
 235                                              int with_comments,
 236                                              <A
 237 HREF="libxml-tree.html#XMLOUTPUTBUFFERPTR"
 238 >xmlOutputBufferPtr</A
 239 > buf);</PRE
 240 ></TD
 241 ></TR
 242 ></TABLE
 243 ></DIV
 244 ><DIV
 245 CLASS="REFSECT1"
 246 ><A
 247 NAME="AEN20762"
 248 ></A
 249 ><H2
 250 >Description</H2
 251 ><P
 252 ></P
 253 ></DIV
 254 ><DIV
 255 CLASS="REFSECT1"
 256 ><A
 257 NAME="AEN20765"
 258 ></A
 259 ><H2
 260 >Details</H2
 261 ><DIV
 262 CLASS="REFSECT2"
 263 ><A
 264 NAME="AEN20767"
 265 ></A
 266 ><H3
 267 ><A
 268 NAME="XMLC14NDOCSAVETO"
 269 ></A
 270 >xmlC14NDocSaveTo ()</H3
 271 ><TABLE
 272 BORDER="0"
 273 BGCOLOR="#D6E8FF"
 274 WIDTH="100%"
 275 CELLPADDING="6"
 276 ><TR
 277 ><TD
 278 ><PRE
 279 CLASS="PROGRAMLISTING"
 280 >int         xmlC14NDocSaveTo                (<A
 281 HREF="libxml-tree.html#XMLDOCPTR"
 282 >xmlDocPtr</A
 283 > doc,
 284                                              <A
 285 HREF="libxml-xpath.html#XMLNODESETPTR"
 286 >xmlNodeSetPtr</A
 287 > nodes,
 288                                              int exclusive,
 289                                              <A
 290 HREF="libxml-tree.html#XMLCHAR"
 291 >xmlChar</A
 292 > **inclusive_ns_prefixes,
 293                                              int with_comments,
 294                                              <A
 295 HREF="libxml-tree.html#XMLOUTPUTBUFFERPTR"
 296 >xmlOutputBufferPtr</A
 297 > buf);</PRE
 298 ></TD
 299 ></TR
 300 ></TABLE
 301 ><P
 302 >Dumps the canonized image of given XML document into the provided buffer.
 303 For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
 304 "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)</P
 305 ><P
 306 ></P
 307 ><DIV
 308 CLASS="INFORMALTABLE"
 309 ><A
 310 NAME="AEN20777"><P
 311 ></P
 312 ><TABLE
 313 BORDER="0"
 314 WIDTH="100%"
 315 BGCOLOR="#FFD0D0"
 316 CELLSPACING="0"
 317 CELLPADDING="4"
 318 CLASS="CALSTABLE"
 319 ><TBODY
 320 ><TR
 321 ><TD
 322 WIDTH="20%"
 323 ALIGN="RIGHT"
 324 VALIGN="TOP"
 325 ><TT
 326 CLASS="PARAMETER"
 327 ><I
 328 >doc</I
 329 ></TT
 330 >&nbsp;:</TD
 331 ><TD
 332 WIDTH="80%"
 333 ALIGN="LEFT"
 334 VALIGN="TOP"
 335 >               the XML document for canonization</TD
 336 ></TR
 337 ><TR
 338 ><TD
 339 WIDTH="20%"
 340 ALIGN="RIGHT"
 341 VALIGN="TOP"
 342 ><TT
 343 CLASS="PARAMETER"
 344 ><I
 345 >nodes</I
 346 ></TT
 347 >&nbsp;:</TD
 348 ><TD
 349 WIDTH="80%"
 350 ALIGN="LEFT"
 351 VALIGN="TOP"
 352 >               the nodes set to be included in the canonized image
 353 or NULL if all document nodes should be included</TD
 354 ></TR
 355 ><TR
 356 ><TD
 357 WIDTH="20%"
 358 ALIGN="RIGHT"
 359 VALIGN="TOP"
 360 ><TT
 361 CLASS="PARAMETER"
 362 ><I
 363 >exclusive</I
 364 ></TT
 365 >&nbsp;:</TD
 366 ><TD
 367 WIDTH="80%"
 368 ALIGN="LEFT"
 369 VALIGN="TOP"
 370 >               the exclusive flag (0 - non-exclusive canonicalization;
 371 otherwise - exclusive canonicalization)</TD
 372 ></TR
 373 ><TR
 374 ><TD
 375 WIDTH="20%"
 376 ALIGN="RIGHT"
 377 VALIGN="TOP"
 378 ><TT
 379 CLASS="PARAMETER"
 380 ><I
 381 >inclusive_ns_prefixes</I
 382 ></TT
 383 >&nbsp;:</TD
 384 ><TD
 385 WIDTH="80%"
 386 ALIGN="LEFT"
 387 VALIGN="TOP"
 388 > the list of inclusive namespace prefixes
 389 ended with a NULL or NULL if there is no
 390 inclusive namespaces (only for exclusive
 391 canonicalization, ignored otherwise)</TD
 392 ></TR
 393 ><TR
 394 ><TD
 395 WIDTH="20%"
 396 ALIGN="RIGHT"
 397 VALIGN="TOP"
 398 ><TT
 399 CLASS="PARAMETER"
 400 ><I
 401 >with_comments</I
 402 ></TT
 403 >&nbsp;:</TD
 404 ><TD
 405 WIDTH="80%"
 406 ALIGN="LEFT"
 407 VALIGN="TOP"
 408 >       include comments in the result (!=0) or not (==0)</TD
 409 ></TR
 410 ><TR
 411 ><TD
 412 WIDTH="20%"
 413 ALIGN="RIGHT"
 414 VALIGN="TOP"
 415 ><TT
 416 CLASS="PARAMETER"
 417 ><I
 418 >buf</I
 419 ></TT
 420 >&nbsp;:</TD
 421 ><TD
 422 WIDTH="80%"
 423 ALIGN="LEFT"
 424 VALIGN="TOP"
 425 >               the output buffer to store canonical XML; this
 426 buffer MUST have encoder==NULL because C14N requires
 427 UTF-8 output</TD
 428 ></TR
 429 ><TR
 430 ><TD
 431 WIDTH="20%"
 432 ALIGN="RIGHT"
 433 VALIGN="TOP"
 434 ><SPAN
 435 CLASS="emphasis"
 436 ><I
 437 CLASS="EMPHASIS"
 438 >Returns</I
 439 ></SPAN
 440 > :</TD
 441 ><TD
 442 WIDTH="80%"
 443 ALIGN="LEFT"
 444 VALIGN="TOP"
 445 >non-negative value on success or a negative value on fail  </TD
 446 ></TR
 447 ></TBODY
 448 ></TABLE
 449 ><P
 450 ></P
 451 ></DIV
 452 ></DIV
 453 ><HR><DIV
 454 CLASS="REFSECT2"
 455 ><A
 456 NAME="AEN20810"
 457 ></A
 458 ><H3
 459 ><A
 460 NAME="XMLC14NDOCDUMPMEMORY"
 461 ></A
 462 >xmlC14NDocDumpMemory ()</H3
 463 ><TABLE
 464 BORDER="0"
 465 BGCOLOR="#D6E8FF"
 466 WIDTH="100%"
 467 CELLPADDING="6"
 468 ><TR
 469 ><TD
 470 ><PRE
 471 CLASS="PROGRAMLISTING"
 472 >int         xmlC14NDocDumpMemory            (<A
 473 HREF="libxml-tree.html#XMLDOCPTR"
 474 >xmlDocPtr</A
 475 > doc,
 476                                              <A
 477 HREF="libxml-xpath.html#XMLNODESETPTR"
 478 >xmlNodeSetPtr</A
 479 > nodes,
 480                                              int exclusive,
 481                                              <A
 482 HREF="libxml-tree.html#XMLCHAR"
 483 >xmlChar</A
 484 > **inclusive_ns_prefixes,
 485                                              int with_comments,
 486                                              <A
 487 HREF="libxml-tree.html#XMLCHAR"
 488 >xmlChar</A
 489 > **doc_txt_ptr);</PRE
 490 ></TD
 491 ></TR
 492 ></TABLE
 493 ><P
 494 >Dumps the canonized image of given XML document into memory.
 495 For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
 496 "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)</P
 497 ><P
 498 ></P
 499 ><DIV
 500 CLASS="INFORMALTABLE"
 501 ><A
 502 NAME="AEN20820"><P
 503 ></P
 504 ><TABLE
 505 BORDER="0"
 506 WIDTH="100%"
 507 BGCOLOR="#FFD0D0"
 508 CELLSPACING="0"
 509 CELLPADDING="4"
 510 CLASS="CALSTABLE"
 511 ><TBODY
 512 ><TR
 513 ><TD
 514 WIDTH="20%"
 515 ALIGN="RIGHT"
 516 VALIGN="TOP"
 517 ><TT
 518 CLASS="PARAMETER"
 519 ><I
 520 >doc</I
 521 ></TT
 522 >&nbsp;:</TD
 523 ><TD
 524 WIDTH="80%"
 525 ALIGN="LEFT"
 526 VALIGN="TOP"
 527 >               the XML document for canonization</TD
 528 ></TR
 529 ><TR
 530 ><TD
 531 WIDTH="20%"
 532 ALIGN="RIGHT"
 533 VALIGN="TOP"
 534 ><TT
 535 CLASS="PARAMETER"
 536 ><I
 537 >nodes</I
 538 ></TT
 539 >&nbsp;:</TD
 540 ><TD
 541 WIDTH="80%"
 542 ALIGN="LEFT"
 543 VALIGN="TOP"
 544 >               the nodes set to be included in the canonized image
 545 or NULL if all document nodes should be included</TD
 546 ></TR
 547 ><TR
 548 ><TD
 549 WIDTH="20%"
 550 ALIGN="RIGHT"
 551 VALIGN="TOP"
 552 ><TT
 553 CLASS="PARAMETER"
 554 ><I
 555 >exclusive</I
 556 ></TT
 557 >&nbsp;:</TD
 558 ><TD
 559 WIDTH="80%"
 560 ALIGN="LEFT"
 561 VALIGN="TOP"
 562 >               the exclusive flag (0 - non-exclusive canonicalization;
 563 otherwise - exclusive canonicalization)</TD
 564 ></TR
 565 ><TR
 566 ><TD
 567 WIDTH="20%"
 568 ALIGN="RIGHT"
 569 VALIGN="TOP"
 570 ><TT
 571 CLASS="PARAMETER"
 572 ><I
 573 >inclusive_ns_prefixes</I
 574 ></TT
 575 >&nbsp;:</TD
 576 ><TD
 577 WIDTH="80%"
 578 ALIGN="LEFT"
 579 VALIGN="TOP"
 580 > the list of inclusive namespace prefixes
 581 ended with a NULL or NULL if there is no
 582 inclusive namespaces (only for exclusive
 583 canonicalization, ignored otherwise)</TD
 584 ></TR
 585 ><TR
 586 ><TD
 587 WIDTH="20%"
 588 ALIGN="RIGHT"
 589 VALIGN="TOP"
 590 ><TT
 591 CLASS="PARAMETER"
 592 ><I
 593 >with_comments</I
 594 ></TT
 595 >&nbsp;:</TD
 596 ><TD
 597 WIDTH="80%"
 598 ALIGN="LEFT"
 599 VALIGN="TOP"
 600 >       include comments in the result (!=0) or not (==0)</TD
 601 ></TR
 602 ><TR
 603 ><TD
 604 WIDTH="20%"
 605 ALIGN="RIGHT"
 606 VALIGN="TOP"
 607 ><TT
 608 CLASS="PARAMETER"
 609 ><I
 610 >doc_txt_ptr</I
 611 ></TT
 612 >&nbsp;:</TD
 613 ><TD
 614 WIDTH="80%"
 615 ALIGN="LEFT"
 616 VALIGN="TOP"
 617 >       the memory pointer for allocated canonical XML text;
 618 the caller of this functions is responsible for calling
 619 <A
 620 HREF="libxml-globals.html#XMLFREE"
 621 >xmlFree</A
 622 >() to free allocated memory </TD
 623 ></TR
 624 ><TR
 625 ><TD
 626 WIDTH="20%"
 627 ALIGN="RIGHT"
 628 VALIGN="TOP"
 629 ><SPAN
 630 CLASS="emphasis"
 631 ><I
 632 CLASS="EMPHASIS"
 633 >Returns</I
 634 ></SPAN
 635 > :</TD
 636 ><TD
 637 WIDTH="80%"
 638 ALIGN="LEFT"
 639 VALIGN="TOP"
 640 >the number of bytes written on success or a negative value on fail  </TD
 641 ></TR
 642 ></TBODY
 643 ></TABLE
 644 ><P
 645 ></P
 646 ></DIV
 647 ></DIV
 648 ><HR><DIV
 649 CLASS="REFSECT2"
 650 ><A
 651 NAME="AEN20854"
 652 ></A
 653 ><H3
 654 ><A
 655 NAME="XMLC14NDOCSAVE"
 656 ></A
 657 >xmlC14NDocSave ()</H3
 658 ><TABLE
 659 BORDER="0"
 660 BGCOLOR="#D6E8FF"
 661 WIDTH="100%"
 662 CELLPADDING="6"
 663 ><TR
 664 ><TD
 665 ><PRE
 666 CLASS="PROGRAMLISTING"
 667 >int         xmlC14NDocSave                  (<A
 668 HREF="libxml-tree.html#XMLDOCPTR"
 669 >xmlDocPtr</A
 670 > doc,
 671                                              <A
 672 HREF="libxml-xpath.html#XMLNODESETPTR"
 673 >xmlNodeSetPtr</A
 674 > nodes,
 675                                              int exclusive,
 676                                              <A
 677 HREF="libxml-tree.html#XMLCHAR"
 678 >xmlChar</A
 679 > **inclusive_ns_prefixes,
 680                                              int with_comments,
 681                                              const char *filename,
 682                                              int compression);</PRE
 683 ></TD
 684 ></TR
 685 ></TABLE
 686 ><P
 687 >Dumps the canonized image of given XML document into the file.
 688 For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
 689 "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)</P
 690 ><P
 691 ></P
 692 ><DIV
 693 CLASS="INFORMALTABLE"
 694 ><A
 695 NAME="AEN20863"><P
 696 ></P
 697 ><TABLE
 698 BORDER="0"
 699 WIDTH="100%"
 700 BGCOLOR="#FFD0D0"
 701 CELLSPACING="0"
 702 CELLPADDING="4"
 703 CLASS="CALSTABLE"
 704 ><TBODY
 705 ><TR
 706 ><TD
 707 WIDTH="20%"
 708 ALIGN="RIGHT"
 709 VALIGN="TOP"
 710 ><TT
 711 CLASS="PARAMETER"
 712 ><I
 713 >doc</I
 714 ></TT
 715 >&nbsp;:</TD
 716 ><TD
 717 WIDTH="80%"
 718 ALIGN="LEFT"
 719 VALIGN="TOP"
 720 >               the XML document for canonization</TD
 721 ></TR
 722 ><TR
 723 ><TD
 724 WIDTH="20%"
 725 ALIGN="RIGHT"
 726 VALIGN="TOP"
 727 ><TT
 728 CLASS="PARAMETER"
 729 ><I
 730 >nodes</I
 731 ></TT
 732 >&nbsp;:</TD
 733 ><TD
 734 WIDTH="80%"
 735 ALIGN="LEFT"
 736 VALIGN="TOP"
 737 >               the nodes set to be included in the canonized image
 738 or NULL if all document nodes should be included</TD
 739 ></TR
 740 ><TR
 741 ><TD
 742 WIDTH="20%"
 743 ALIGN="RIGHT"
 744 VALIGN="TOP"
 745 ><TT
 746 CLASS="PARAMETER"
 747 ><I
 748 >exclusive</I
 749 ></TT
 750 >&nbsp;:</TD
 751 ><TD
 752 WIDTH="80%"
 753 ALIGN="LEFT"
 754 VALIGN="TOP"
 755 >               the exclusive flag (0 - non-exclusive canonicalization;
 756 otherwise - exclusive canonicalization)</TD
 757 ></TR
 758 ><TR
 759 ><TD
 760 WIDTH="20%"
 761 ALIGN="RIGHT"
 762 VALIGN="TOP"
 763 ><TT
 764 CLASS="PARAMETER"
 765 ><I
 766 >inclusive_ns_prefixes</I
 767 ></TT
 768 >&nbsp;:</TD
 769 ><TD
 770 WIDTH="80%"
 771 ALIGN="LEFT"
 772 VALIGN="TOP"
 773 > the list of inclusive namespace prefixes
 774 ended with a NULL or NULL if there is no
 775 inclusive namespaces (only for exclusive
 776 canonicalization, ignored otherwise)</TD
 777 ></TR
 778 ><TR
 779 ><TD
 780 WIDTH="20%"
 781 ALIGN="RIGHT"
 782 VALIGN="TOP"
 783 ><TT
 784 CLASS="PARAMETER"
 785 ><I
 786 >with_comments</I
 787 ></TT
 788 >&nbsp;:</TD
 789 ><TD
 790 WIDTH="80%"
 791 ALIGN="LEFT"
 792 VALIGN="TOP"
 793 >       include comments in the result (!=0) or not (==0)</TD
 794 ></TR
 795 ><TR
 796 ><TD
 797 WIDTH="20%"
 798 ALIGN="RIGHT"
 799 VALIGN="TOP"
 800 ><TT
 801 CLASS="PARAMETER"
 802 ><I
 803 >filename</I
 804 ></TT
 805 >&nbsp;:</TD
 806 ><TD
 807 WIDTH="80%"
 808 ALIGN="LEFT"
 809 VALIGN="TOP"
 810 >               the filename to store canonical XML image</TD
 811 ></TR
 812 ><TR
 813 ><TD
 814 WIDTH="20%"
 815 ALIGN="RIGHT"
 816 VALIGN="TOP"
 817 ><TT
 818 CLASS="PARAMETER"
 819 ><I
 820 >compression</I
 821 ></TT
 822 >&nbsp;:</TD
 823 ><TD
 824 WIDTH="80%"
 825 ALIGN="LEFT"
 826 VALIGN="TOP"
 827 >       the compression level (zlib requred):
 828 -1 - libxml default,
 829 0 - uncompressed,
 830 &gt;0 - compression level</TD
 831 ></TR
 832 ><TR
 833 ><TD
 834 WIDTH="20%"
 835 ALIGN="RIGHT"
 836 VALIGN="TOP"
 837 ><SPAN
 838 CLASS="emphasis"
 839 ><I
 840 CLASS="EMPHASIS"
 841 >Returns</I
 842 ></SPAN
 843 > :</TD
 844 ><TD
 845 WIDTH="80%"
 846 ALIGN="LEFT"
 847 VALIGN="TOP"
 848 >the number of bytes written success or a negative value on fail  </TD
 849 ></TR
 850 ></TBODY
 851 ></TABLE
 852 ><P
 853 ></P
 854 ></DIV
 855 ></DIV
 856 ><HR><DIV
 857 CLASS="REFSECT2"
 858 ><A
 859 NAME="AEN20900"
 860 ></A
 861 ><H3
 862 ><A
 863 NAME="XMLC14NISVISIBLECALLBACK"
 864 ></A
 865 >xmlC14NIsVisibleCallback ()</H3
 866 ><TABLE
 867 BORDER="0"
 868 BGCOLOR="#D6E8FF"
 869 WIDTH="100%"
 870 CELLPADDING="6"
 871 ><TR
 872 ><TD
 873 ><PRE
 874 CLASS="PROGRAMLISTING"
 875 >int         (*xmlC14NIsVisibleCallback)     (void *user_data,
 876                                              <A
 877 HREF="libxml-tree.html#XMLNODEPTR"
 878 >xmlNodePtr</A
 879 > node,
 880                                              <A
 881 HREF="libxml-tree.html#XMLNODEPTR"
 882 >xmlNodePtr</A
 883 > parent);</PRE
 884 ></TD
 885 ></TR
 886 ></TABLE
 887 ><P
 888 ></P
 889 ><DIV
 890 CLASS="INFORMALTABLE"
 891 ><A
 892 NAME="AEN20907"><P
 893 ></P
 894 ><TABLE
 895 BORDER="0"
 896 WIDTH="100%"
 897 BGCOLOR="#FFD0D0"
 898 CELLSPACING="0"
 899 CELLPADDING="4"
 900 CLASS="CALSTABLE"
 901 ><TBODY
 902 ><TR
 903 ><TD
 904 WIDTH="20%"
 905 ALIGN="RIGHT"
 906 VALIGN="TOP"
 907 ><TT
 908 CLASS="PARAMETER"
 909 ><I
 910 >user_data</I
 911 ></TT
 912 >&nbsp;:</TD
 913 ><TD
 914 WIDTH="80%"
 915 ALIGN="LEFT"
 916 VALIGN="TOP"
 917 >&nbsp;</TD
 918 ></TR
 919 ><TR
 920 ><TD
 921 WIDTH="20%"
 922 ALIGN="RIGHT"
 923 VALIGN="TOP"
 924 ><TT
 925 CLASS="PARAMETER"
 926 ><I
 927 >node</I
 928 ></TT
 929 >&nbsp;:</TD
 930 ><TD
 931 WIDTH="80%"
 932 ALIGN="LEFT"
 933 VALIGN="TOP"
 934 >&nbsp;</TD
 935 ></TR
 936 ><TR
 937 ><TD
 938 WIDTH="20%"
 939 ALIGN="RIGHT"
 940 VALIGN="TOP"
 941 ><TT
 942 CLASS="PARAMETER"
 943 ><I
 944 >parent</I
 945 ></TT
 946 >&nbsp;:</TD
 947 ><TD
 948 WIDTH="80%"
 949 ALIGN="LEFT"
 950 VALIGN="TOP"
 951 >&nbsp;</TD
 952 ></TR
 953 ><TR
 954 ><TD
 955 WIDTH="20%"
 956 ALIGN="RIGHT"
 957 VALIGN="TOP"
 958 ><SPAN
 959 CLASS="emphasis"
 960 ><I
 961 CLASS="EMPHASIS"
 962 >Returns</I
 963 ></SPAN
 964 > :</TD
 965 ><TD
 966 WIDTH="80%"
 967 ALIGN="LEFT"
 968 VALIGN="TOP"
 969 >&nbsp;</TD
 970 ></TR
 971 ></TBODY
 972 ></TABLE
 973 ><P
 974 ></P
 975 ></DIV
 976 ></DIV
 977 ><HR><DIV
 978 CLASS="REFSECT2"
 979 ><A
 980 NAME="AEN20928"
 981 ></A
 982 ><H3
 983 ><A
 984 NAME="XMLC14NEXECUTE"
 985 ></A
 986 >xmlC14NExecute ()</H3
 987 ><TABLE
 988 BORDER="0"
 989 BGCOLOR="#D6E8FF"
 990 WIDTH="100%"
 991 CELLPADDING="6"
 992 ><TR
 993 ><TD
 994 ><PRE
 995 CLASS="PROGRAMLISTING"
 996 >int         xmlC14NExecute                  (<A
 997 HREF="libxml-tree.html#XMLDOCPTR"
 998 >xmlDocPtr</A
 999 > doc,
1000                                              <A
1001 HREF="libxml-c14n.html#XMLC14NISVISIBLECALLBACK"
1002 >xmlC14NIsVisibleCallback</A
1003 > is_visible_callback,
1004                                              void *user_data,
1005                                              int exclusive,
1006                                              <A
1007 HREF="libxml-tree.html#XMLCHAR"
1008 >xmlChar</A
1009 > **inclusive_ns_prefixes,
1010                                              int with_comments,
1011                                              <A
1012 HREF="libxml-tree.html#XMLOUTPUTBUFFERPTR"
1013 >xmlOutputBufferPtr</A
1014 > buf);</PRE
1015 ></TD
1016 ></TR
1017 ></TABLE
1018 ><P
1019 >Dumps the canonized image of given XML document into the provided buffer.
1020 For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
1021 "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)</P
1022 ><P
1023 ></P
1024 ><DIV
1025 CLASS="INFORMALTABLE"
1026 ><A
1027 NAME="AEN20938"><P
1028 ></P
1029 ><TABLE
1030 BORDER="0"
1031 WIDTH="100%"
1032 BGCOLOR="#FFD0D0"
1033 CELLSPACING="0"
1034 CELLPADDING="4"
1035 CLASS="CALSTABLE"
1036 ><TBODY
1037 ><TR
1038 ><TD
1039 WIDTH="20%"
1040 ALIGN="RIGHT"
1041 VALIGN="TOP"
1042 ><TT
1043 CLASS="PARAMETER"
1044 ><I
1045 >doc</I
1046 ></TT
1047 >&nbsp;:</TD
1048 ><TD
1049 WIDTH="80%"
1050 ALIGN="LEFT"
1051 VALIGN="TOP"
1052 >               the XML document for canonization</TD
1053 ></TR
1054 ><TR
1055 ><TD
1056 WIDTH="20%"
1057 ALIGN="RIGHT"
1058 VALIGN="TOP"
1059 ><TT
1060 CLASS="PARAMETER"
1061 ><I
1062 >is_visible_callback</I
1063 ></TT
1064 >&nbsp;:</TD
1065 ><TD
1066 WIDTH="80%"
1067 ALIGN="LEFT"
1068 VALIGN="TOP"
1069 >the function to use to determine is node visible
1070 or not</TD
1071 ></TR
1072 ><TR
1073 ><TD
1074 WIDTH="20%"
1075 ALIGN="RIGHT"
1076 VALIGN="TOP"
1077 ><TT
1078 CLASS="PARAMETER"
1079 ><I
1080 >user_data</I
1081 ></TT
1082 >&nbsp;:</TD
1083 ><TD
1084 WIDTH="80%"
1085 ALIGN="LEFT"
1086 VALIGN="TOP"
1087 >               the first parameter for <TT
1088 CLASS="PARAMETER"
1089 ><I
1090 >is_visible_callback</I
1091 ></TT
1092 > function
1093 (in most cases, it is nodes set)</TD
1094 ></TR
1095 ><TR
1096 ><TD
1097 WIDTH="20%"
1098 ALIGN="RIGHT"
1099 VALIGN="TOP"
1100 ><TT
1101 CLASS="PARAMETER"
1102 ><I
1103 >exclusive</I
1104 ></TT
1105 >&nbsp;:</TD
1106 ><TD
1107 WIDTH="80%"
1108 ALIGN="LEFT"
1109 VALIGN="TOP"
1110 >               the exclusive flag (0 - non-exclusive canonicalization;
1111 otherwise - exclusive canonicalization)</TD
1112 ></TR
1113 ><TR
1114 ><TD
1115 WIDTH="20%"
1116 ALIGN="RIGHT"
1117 VALIGN="TOP"
1118 ><TT
1119 CLASS="PARAMETER"
1120 ><I
1121 >inclusive_ns_prefixes</I
1122 ></TT
1123 >&nbsp;:</TD
1124 ><TD
1125 WIDTH="80%"
1126 ALIGN="LEFT"
1127 VALIGN="TOP"
1128 > the list of inclusive namespace prefixes
1129 ended with a NULL or NULL if there is no
1130 inclusive namespaces (only for exclusive
1131 canonicalization, ignored otherwise)</TD
1132 ></TR
1133 ><TR
1134 ><TD
1135 WIDTH="20%"
1136 ALIGN="RIGHT"
1137 VALIGN="TOP"
1138 ><TT
1139 CLASS="PARAMETER"
1140 ><I
1141 >with_comments</I
1142 ></TT
1143 >&nbsp;:</TD
1144 ><TD
1145 WIDTH="80%"
1146 ALIGN="LEFT"
1147 VALIGN="TOP"
1148 >       include comments in the result (!=0) or not (==0)</TD
1149 ></TR
1150 ><TR
1151 ><TD
1152 WIDTH="20%"
1153 ALIGN="RIGHT"
1154 VALIGN="TOP"
1155 ><TT
1156 CLASS="PARAMETER"
1157 ><I
1158 >buf</I
1159 ></TT
1160 >&nbsp;:</TD
1161 ><TD
1162 WIDTH="80%"
1163 ALIGN="LEFT"
1164 VALIGN="TOP"
1165 >               the output buffer to store canonical XML; this
1166 buffer MUST have encoder==NULL because C14N requires
1167 UTF-8 output</TD
1168 ></TR
1169 ><TR
1170 ><TD
1171 WIDTH="20%"
1172 ALIGN="RIGHT"
1173 VALIGN="TOP"
1174 ><SPAN
1175 CLASS="emphasis"
1176 ><I
1177 CLASS="EMPHASIS"
1178 >Returns</I
1179 ></SPAN
1180 > :</TD
1181 ><TD
1182 WIDTH="80%"
1183 ALIGN="LEFT"
1184 VALIGN="TOP"
1185 >non-negative value on success or a negative value on fail  </TD
1186 ></TR
1187 ></TBODY
1188 ></TABLE
1189 ><P
1190 ></P
1191 ></DIV
1192 ></DIV
1193 ></DIV
1194 ><DIV
1195 CLASS="NAVFOOTER"
1196 ><BR
1197 CLEAR="all"><BR><TABLE
1198 WIDTH="100%"
1199 BORDER="0"
1200 BGCOLOR="#000000"
1201 CELLPADDING="1"
1202 CELLSPACING="0"
1203 ><TR
1204 ><TD
1205 WIDTH="25%"
1206 BGCOLOR="#C00000"
1207 ALIGN="left"
1208 ><A
1209 HREF="libxml-catalog.html"
1210 ><FONT
1211 COLOR="#FFFFFF"
1212 SIZE="3"
1213 ><B
1214 >&#60;&#60;&#60; Previous Page</B
1215 ></FONT
1216 ></A
1217 ></TD
1218 ><TD
1219 WIDTH="25%"
1220 BGCOLOR="#0000C0"
1221 ALIGN="center"
1222 ><FONT
1223 COLOR="#FFFFFF"
1224 SIZE="3"
1225 ><B
1226 ><A
1227 HREF="book1.html"
1228 ><FONT
1229 COLOR="#FFFFFF"
1230 SIZE="3"
1231 ><B
1232 >Home</B
1233 ></FONT
1234 ></A
1235 ></B
1236 ></FONT
1237 ></TD
1238 ><TD
1239 WIDTH="25%"
1240 BGCOLOR="#00C000"
1241 ALIGN="center"
1242 ><FONT
1243 COLOR="#FFFFFF"
1244 SIZE="3"
1245 ><B
1246 ><A
1247 HREF="libxml-lib.html"
1248 ><FONT
1249 COLOR="#FFFFFF"
1250 SIZE="3"
1251 ><B
1252 >Up</B
1253 ></FONT
1254 ></A
1255 ></B
1256 ></FONT
1257 ></TD
1258 ><TD
1259 WIDTH="25%"
1260 BGCOLOR="#C00000"
1261 ALIGN="right"
1262 ><A
1263 HREF="libxml-threads.html"
1264 ><FONT
1265 COLOR="#FFFFFF"
1266 SIZE="3"
1267 ><B
1268 >Next Page &#62;&#62;&#62;</B
1269 ></FONT
1270 ></A
1271 ></TD
1272 ></TR
1273 ><TR
1274 ><TD
1275 COLSPAN="2"
1276 ALIGN="left"
1277 ><FONT
1278 COLOR="#FFFFFF"
1279 SIZE="3"
1280 ><B
1281 >catalog</B
1282 ></FONT
1283 ></TD
1284 ><TD
1285 COLSPAN="2"
1286 ALIGN="right"
1287 ><FONT
1288 COLOR="#FFFFFF"
1289 SIZE="3"
1290 ><B
1291 >threads</B
1292 ></FONT
1293 ></TD
1294 ></TR
1295 ></TABLE
1296 ></DIV
1297 ></BODY
1298 ></HTML
1299 >