kc3-lang/libxml2/doc/html/libxml-c14n.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-c14n.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
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>c14n</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-catalog.html" title="catalog"><link rel="next" href="libxml-threads.html" title="threads"></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-catalog.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-threads.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-c14n"></a><div class="titlepage"></div><div class="refnamediv"><h2>c14n</h2><p>c14n — </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis"> int <a href="libxml-c14n.html#xmlC14NDocSaveTo">xmlC14NDocSaveTo</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <a href="libxml-xpath.html#xmlNodeSetPtr">xmlNodeSetPtr</a> nodes, int exclusive, <a href="libxml-tree.html#xmlChar">xmlChar</a> **inclusive_ns_prefixes, int with_comments, <a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> buf); int <a href="libxml-c14n.html#xmlC14NDocDumpMemory">xmlC14NDocDumpMemory</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <a href="libxml-xpath.html#xmlNodeSetPtr">xmlNodeSetPtr</a> nodes, int exclusive, <a href="libxml-tree.html#xmlChar">xmlChar</a> **inclusive_ns_prefixes, int with_comments, <a href="libxml-tree.html#xmlChar">xmlChar</a> **doc_txt_ptr); int <a href="libxml-c14n.html#xmlC14NDocSave">xmlC14NDocSave</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <a href="libxml-xpath.html#xmlNodeSetPtr">xmlNodeSetPtr</a> nodes, int exclusive, <a href="libxml-tree.html#xmlChar">xmlChar</a> **inclusive_ns_prefixes, int with_comments, const char *filename, int compression); int (<a href="libxml-c14n.html#xmlC14NIsVisibleCallback">*xmlC14NIsVisibleCallback</a>) (void *user_data, <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node, <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> parent); int <a href="libxml-c14n.html#xmlC14NExecute">xmlC14NExecute</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <a href="libxml-c14n.html#xmlC14NIsVisibleCallback">xmlC14NIsVisibleCallback</a> is_visible_callback, void *user_data, int exclusive, <a href="libxml-tree.html#xmlChar">xmlChar</a> **inclusive_ns_prefixes, int with_comments, <a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> buf); </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="xmlC14NDocSaveTo"></a>xmlC14NDocSaveTo ()</h3><pre class="programlisting">int xmlC14NDocSaveTo (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <a href="libxml-xpath.html#xmlNodeSetPtr">xmlNodeSetPtr</a> nodes, int exclusive, <a href="libxml-tree.html#xmlChar">xmlChar</a> **inclusive_ns_prefixes, int with_comments, <a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> buf);</pre><p> Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td> the XML document for canonization </td></tr><tr><td><span class="term"><i><tt>nodes</tt></i> :</span></td><td> the nodes set to be included in the canonized image or NULL if all document nodes should be included </td></tr><tr><td><span class="term"><i><tt>exclusive</tt></i> :</span></td><td> the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) </td></tr><tr><td><span class="term"><i><tt>inclusive_ns_prefixes</tt></i> :</span></td><td> the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) </td></tr><tr><td><span class="term"><i><tt>with_comments</tt></i> :</span></td><td> include comments in the result (!=0) or not (==0) </td></tr><tr><td><span class="term"><i><tt>buf</tt></i> :</span></td><td> the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>non-negative value on success or a negative value on fail </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlC14NDocDumpMemory"></a>xmlC14NDocDumpMemory ()</h3><pre class="programlisting">int xmlC14NDocDumpMemory (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <a href="libxml-xpath.html#xmlNodeSetPtr">xmlNodeSetPtr</a> nodes, int exclusive, <a href="libxml-tree.html#xmlChar">xmlChar</a> **inclusive_ns_prefixes, int with_comments, <a href="libxml-tree.html#xmlChar">xmlChar</a> **doc_txt_ptr);</pre><p> Dumps the canonized image of given XML document into memory. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td> the XML document for canonization </td></tr><tr><td><span class="term"><i><tt>nodes</tt></i> :</span></td><td> the nodes set to be included in the canonized image or NULL if all document nodes should be included </td></tr><tr><td><span class="term"><i><tt>exclusive</tt></i> :</span></td><td> the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) </td></tr><tr><td><span class="term"><i><tt>inclusive_ns_prefixes</tt></i> :</span></td><td> the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) </td></tr><tr><td><span class="term"><i><tt>with_comments</tt></i> :</span></td><td> include comments in the result (!=0) or not (==0) </td></tr><tr><td><span class="term"><i><tt>doc_txt_ptr</tt></i> :</span></td><td> the memory pointer for allocated canonical XML text; the caller of this functions is responsible for calling <a href="libxml-globals.html#xmlFree">xmlFree</a>() to free allocated memory </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of bytes written on success or a negative value on fail </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlC14NDocSave"></a>xmlC14NDocSave ()</h3><pre class="programlisting">int xmlC14NDocSave (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <a href="libxml-xpath.html#xmlNodeSetPtr">xmlNodeSetPtr</a> nodes, int exclusive, <a href="libxml-tree.html#xmlChar">xmlChar</a> **inclusive_ns_prefixes, int with_comments, const char *filename, int compression);</pre><p> Dumps the canonized image of given XML document into the file. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td> the XML document for canonization </td></tr><tr><td><span class="term"><i><tt>nodes</tt></i> :</span></td><td> the nodes set to be included in the canonized image or NULL if all document nodes should be included </td></tr><tr><td><span class="term"><i><tt>exclusive</tt></i> :</span></td><td> the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) </td></tr><tr><td><span class="term"><i><tt>inclusive_ns_prefixes</tt></i> :</span></td><td> the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) </td></tr><tr><td><span class="term"><i><tt>with_comments</tt></i> :</span></td><td> include comments in the result (!=0) or not (==0) </td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the filename to store canonical XML image </td></tr><tr><td><span class="term"><i><tt>compression</tt></i> :</span></td><td> the compression level (zlib requred): -1 - libxml default, 0 - uncompressed, >0 - compression level </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of bytes written success or a negative value on fail </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlC14NIsVisibleCallback"></a>xmlC14NIsVisibleCallback ()</h3><pre class="programlisting">int (*xmlC14NIsVisibleCallback) (void *user_data, <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node, <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> parent);</pre><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>user_data</tt></i> :</span></td><td> </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> </td></tr><tr><td><span class="term"><i><tt>parent</tt></i> :</span></td><td> </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlC14NExecute"></a>xmlC14NExecute ()</h3><pre class="programlisting">int xmlC14NExecute (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc, <a href="libxml-c14n.html#xmlC14NIsVisibleCallback">xmlC14NIsVisibleCallback</a> is_visible_callback, void *user_data, int exclusive, <a href="libxml-tree.html#xmlChar">xmlChar</a> **inclusive_ns_prefixes, int with_comments, <a href="libxml-tree.html#xmlOutputBufferPtr">xmlOutputBufferPtr</a> buf);</pre><p> Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)</p><p> </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td> the XML document for canonization </td></tr><tr><td><span class="term"><i><tt>is_visible_callback</tt></i> :</span></td><td>the function to use to determine is node visible or not </td></tr><tr><td><span class="term"><i><tt>user_data</tt></i> :</span></td><td> the first parameter for <i><tt>is_visible_callback</tt></i> function (in most cases, it is nodes set) </td></tr><tr><td><span class="term"><i><tt>exclusive</tt></i> :</span></td><td> the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) </td></tr><tr><td><span class="term"><i><tt>inclusive_ns_prefixes</tt></i> :</span></td><td> the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) </td></tr><tr><td><span class="term"><i><tt>with_comments</tt></i> :</span></td><td> include comments in the result (!=0) or not (==0) </td></tr><tr><td><span class="term"><i><tt>buf</tt></i> :</span></td><td> the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>non-negative value on success or a negative value on fail </td></tr></tbody></table></div></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-catalog.html"><b><< catalog</b></a></td><td align="right"><a accesskey="n" href="libxml-threads.html"><b>threads >></b></a></td></tr></table></body></html>