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