  
    
    
    
    
    
    
    
  
  
    
      
        
          
libxml2-SAX2.html            
Prev          
        
        
          
general.html            
Up          
        
        
          
index.html            
Home          
        
        
          
libxml2-catalog.html            
Next          
        
        
libxml2 Reference Manual      
    
    
      
c14n    
    
c14n - Provide Canonical XML and Exclusive XML Canonicalization
    
the c14n modules provides a  "Canonical XML" implementation
    
Author(s): Aleksey Sanin <aleksey@aleksey.com> 
    
      
Synopsis
      
int	#xmlC14NExecutexmlC14NExecute 			( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-c14n.html#xmlC14NIsVisibleCallbackxmlC14NIsVisibleCallback  is_visible_callback, 					 void * user_data, 					 int exclusive, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** inclusive_ns_prefixes, 					 int with_comments, 					 libxml2-tree.html#xmlOutputBufferPtrxmlOutputBufferPtr  buf);
int	
#xmlC14NDocSaveToxmlC14NDocSaveTo 		( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-xpath.html#xmlNodeSetPtrxmlNodeSetPtr  nodes, 					 int exclusive, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** inclusive_ns_prefixes, 					 int with_comments, 					 libxml2-tree.html#xmlOutputBufferPtrxmlOutputBufferPtr  buf);
typedef int 
#xmlC14NIsVisibleCallbackxmlC14NIsVisibleCallback 	(void * user_data, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  parent);
int	
#xmlC14NDocSavexmlC14NDocSave 			( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-xpath.html#xmlNodeSetPtrxmlNodeSetPtr  nodes, 					 int exclusive, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** inclusive_ns_prefixes, 					 int with_comments, 					 const char * filename, 					 int compression);
int	
#xmlC14NDocDumpMemoryxmlC14NDocDumpMemory 		( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-xpath.html#xmlNodeSetPtrxmlNodeSetPtr  nodes, 					 int exclusive, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** inclusive_ns_prefixes, 					 int with_comments, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** doc_txt_ptr);
    
    
      
Description
    
    
      
Details
      
        
Function type xmlC14NIsVisibleCallback
int	xmlC14NIsVisibleCallback	(void * user_data, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  node, 					 libxml2-tree.html#xmlNodePtrxmlNodePtr  parent) user_data: node: parent: Returns:         
        
xmlC14NDocDumpMemory ()
int	xmlC14NDocDumpMemory		( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-xpath.html#xmlNodeSetPtrxmlNodeSetPtr  nodes, 					 int exclusive, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** inclusive_ns_prefixes, 					 int with_comments, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** doc_txt_ptr)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)
doc: the XML document for canonization nodes: the nodes set to be included in the canonized image or NULL if all document nodes should be included exclusive: the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) inclusive_ns_prefixes: the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) with_comments: include comments in the result (!=0) or not (==0) doc_txt_ptr: the memory pointer for allocated canonical XML text; the caller of this functions is responsible for calling xmlFree() to free allocated memory Returns: the number of bytes written on success or a negative value on fail         
        
xmlC14NDocSave ()
int	xmlC14NDocSave			( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-xpath.html#xmlNodeSetPtrxmlNodeSetPtr  nodes, 					 int exclusive, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** inclusive_ns_prefixes, 					 int with_comments, 					 const char * filename, 					 int compression)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)
doc: the XML document for canonization nodes: the nodes set to be included in the canonized image or NULL if all document nodes should be included exclusive: the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) inclusive_ns_prefixes: the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) with_comments: include comments in the result (!=0) or not (==0) filename: the filename to store canonical XML image compression: the compression level (zlib requred): -1 - libxml default, 0 - uncompressed, >0 - compression level Returns: the number of bytes written success or a negative value on fail         
        
xmlC14NDocSaveTo ()
int	xmlC14NDocSaveTo		( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-xpath.html#xmlNodeSetPtrxmlNodeSetPtr  nodes, 					 int exclusive, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** inclusive_ns_prefixes, 					 int with_comments, 					 libxml2-tree.html#xmlOutputBufferPtrxmlOutputBufferPtr  buf)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)
doc: the XML document for canonization nodes: the nodes set to be included in the canonized image or NULL if all document nodes should be included exclusive: the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) inclusive_ns_prefixes: the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) with_comments: include comments in the result (!=0) or not (==0) buf: the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output Returns: non-negative value on success or a negative value on fail         
        
xmlC14NExecute ()
int	xmlC14NExecute			( libxml2-tree.html#xmlDocPtrxmlDocPtr  doc, 					 libxml2-c14n.html#xmlC14NIsVisibleCallbackxmlC14NIsVisibleCallback  is_visible_callback, 					 void * user_data, 					 int exclusive, 					 libxml2-xmlstring.html#xmlCharxmlChar  ** inclusive_ns_prefixes, 					 int with_comments, 					 libxml2-tree.html#xmlOutputBufferPtrxmlOutputBufferPtr  buf)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)
doc: the XML document for canonization is_visible_callback: the function to use to determine is node visible or not user_data: the first parameter for @is_visible_callback function (in most cases, it is nodes set) exclusive: the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization) inclusive_ns_prefixes: the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise) with_comments: include comments in the result (!=0) or not (==0) buf: the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output Returns: non-negative value on success or a negative value on fail         
      
    
  
