|
Packit Service |
a31ea6 |
|
|
Packit Service |
a31ea6 |
|
|
Packit Service |
a31ea6 |
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="SHORTCUT ICON" href="/favicon.ico" /><style type="text/css">
|
|
Packit Service |
a31ea6 |
TD {font-family: Verdana,Arial,Helvetica}
|
|
Packit Service |
a31ea6 |
BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
|
|
Packit Service |
a31ea6 |
H1 {font-family: Verdana,Arial,Helvetica}
|
|
Packit Service |
a31ea6 |
H2 {font-family: Verdana,Arial,Helvetica}
|
|
Packit Service |
a31ea6 |
H3 {font-family: Verdana,Arial,Helvetica}
|
|
Packit Service |
a31ea6 |
A:link, A:visited, A:active { text-decoration: underline }
|
|
Packit Service |
a31ea6 |
</style><style type="text/css">
|
|
Packit Service |
a31ea6 |
div.deprecated pre.programlisting {border-style: double;border-color:red}
|
|
Packit Service |
a31ea6 |
pre.programlisting {border-style: double;background: #EECFA1}
|
|
Packit Service |
a31ea6 |
</style><title>Module c14n from libxml2</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000"><center>API Menu</center> | <form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="20" value="" /><input name="submit" type="submit" value="Search ..." /></form> |
<center>API Indexes</center> | |
<center>Related links</center> | |
|
| the c14n modules provides a "Canonical XML" implementation Table of ContentsEnum xmlC14NMode |
|
|
|
|
|
|
Packit Service |
a31ea6 |
int xmlC14NDocDumpMemory (xmlDocPtr doc, xmlNodeSetPtr nodes, int mode, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlChar ** doc_txt_ptr)
|
|
Packit Service |
a31ea6 |
int xmlC14NDocSave (xmlDocPtr doc, xmlNodeSetPtr nodes, int mode, xmlChar ** inclusive_ns_prefixes, int with_comments, const char * filename, int compression)
|
|
Packit Service |
a31ea6 |
int xmlC14NDocSaveTo (xmlDocPtr doc, xmlNodeSetPtr nodes, int mode, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlOutputBufferPtr buf)
|
|
Packit Service |
a31ea6 |
int xmlC14NExecute (xmlDocPtr doc, xmlC14NIsVisibleCallback is_visible_callback, void * user_data, int mode, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlOutputBufferPtr buf)
|
|
Packit Service |
a31ea6 |
Function type: xmlC14NIsVisibleCallback
|
|
Packit Service |
a31ea6 |
int xmlC14NIsVisibleCallback (void * user_data, xmlNodePtr node, xmlNodePtr parent)
|
|
Packit Service |
a31ea6 |
|
|
Packit Service |
a31ea6 |
Description
|
|
Packit Service |
a31ea6 |
Enum xmlC14NMode {
|
|
Packit Service |
a31ea6 |
XML_C14N_1_0 = 0 : Origianal C14N 1.0 spec
|
|
Packit Service |
a31ea6 |
XML_C14N_EXCLUSIVE_1_0 = 1 : Exclusive C14N 1.0 spec
|
|
Packit Service |
a31ea6 |
XML_C14N_1_1 = 2 : C14N 1.1 spec
|
|
Packit Service |
a31ea6 |
}
|
|
Packit Service |
a31ea6 |
Function: xmlC14NDocDumpMemoryint xmlC14NDocDumpMemory (xmlDocPtr doc, xmlNodeSetPtr nodes, int mode, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlChar ** doc_txt_ptr)
|
|
Packit Service |
a31ea6 |
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)
|
|
Packit Service |
a31ea6 |
<tt>doc</tt>: | the XML document for canonization | <tt>nodes</tt>: | the nodes set to be included in the canonized image or NULL if all document nodes should be included | <tt>mode</tt>: | the c14n mode (see @xmlC14NMode) | <tt>inclusive_ns_prefixes</tt>: | the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) | <tt>with_comments</tt>: | include comments in the result (!=0) or not (==0) | <tt>doc_txt_ptr</tt>: | the memory pointer for allocated canonical XML text; the caller of this functions is responsible for calling xmlFree() to free allocated memory | <tt>Returns</tt>: | the number of bytes written on success or a negative value on fail |
Function: xmlC14NDocSaveint xmlC14NDocSave (xmlDocPtr doc, xmlNodeSetPtr nodes, int mode, xmlChar ** inclusive_ns_prefixes, int with_comments, const char * filename, int compression)
|
|
Packit Service |
a31ea6 |
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)
|
|
Packit Service |
a31ea6 |
<tt>doc</tt>: | the XML document for canonization | <tt>nodes</tt>: | the nodes set to be included in the canonized image or NULL if all document nodes should be included | <tt>mode</tt>: | the c14n mode (see @xmlC14NMode) | <tt>inclusive_ns_prefixes</tt>: | the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) | <tt>with_comments</tt>: | include comments in the result (!=0) or not (==0) | <tt>filename</tt>: | the filename to store canonical XML image | <tt>compression</tt>: | the compression level (zlib requred): -1 - libxml default, 0 - uncompressed, >0 - compression level | <tt>Returns</tt>: | the number of bytes written success or a negative value on fail |
Function: xmlC14NDocSaveToint xmlC14NDocSaveTo (xmlDocPtr doc, xmlNodeSetPtr nodes, int mode, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlOutputBufferPtr buf)
|
|
Packit Service |
a31ea6 |
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)
|
|
Packit Service |
a31ea6 |
<tt>doc</tt>: | the XML document for canonization | <tt>nodes</tt>: | the nodes set to be included in the canonized image or NULL if all document nodes should be included | <tt>mode</tt>: | the c14n mode (see @xmlC14NMode) | <tt>inclusive_ns_prefixes</tt>: | the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) | <tt>with_comments</tt>: | include comments in the result (!=0) or not (==0) | <tt>buf</tt>: | the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output | <tt>Returns</tt>: | non-negative value on success or a negative value on fail |
Function: xmlC14NExecuteint xmlC14NExecute (xmlDocPtr doc, xmlC14NIsVisibleCallback is_visible_callback, void * user_data, int mode, xmlChar ** inclusive_ns_prefixes, int with_comments, xmlOutputBufferPtr buf)
|
|
Packit Service |
a31ea6 |
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)
|
|
Packit Service |
a31ea6 |
<tt>doc</tt>: | the XML document for canonization | <tt>is_visible_callback</tt>: | the function to use to determine is node visible or not | <tt>user_data</tt>: | the first parameter for @is_visible_callback function (in most cases, it is nodes set) | <tt>mode</tt>: | the c14n mode (see @xmlC14NMode) | <tt>inclusive_ns_prefixes</tt>: | the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) | <tt>with_comments</tt>: | include comments in the result (!=0) or not (==0) | <tt>buf</tt>: | the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output | <tt>Returns</tt>: | non-negative value on success or a negative value on fail |
Function type: xmlC14NIsVisibleCallbackFunction type: xmlC14NIsVisibleCallback
|
|
Packit Service |
a31ea6 |
int xmlC14NIsVisibleCallback (void * user_data, xmlNodePtr node, xmlNodePtr parent)
|
|
Packit Service |
a31ea6 |
Signature for a C14N callback on visible nodes <tt>user_data</tt>: | user data | <tt>node</tt>: | the curent node | <tt>parent</tt>: | the parent node | <tt>Returns</tt>: | 1 if the node should be included |
|
|
Packit Service |
a31ea6 |
Daniel Veillard </body></html>
|