Blame doc/devhelp/libxml2-tree.html

Packit 423ecb
Packit 423ecb
<html>
Packit 423ecb
  <head>
Packit 423ecb
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
Packit 423ecb
    <title>tree: interfaces for tree manipulation</title>
Packit 423ecb
    <meta name="generator" content="Libxml2 devhelp stylesheet"/>
Packit 423ecb
    <link rel="start" href="index.html" title="libxml2 Reference Manual"/>
Packit 423ecb
    <link rel="up" href="general.html" title="API"/>
Packit 423ecb
    <link rel="stylesheet" href="style.css" type="text/css"/>
Packit 423ecb
    <link rel="chapter" href="general.html" title="API"/>
Packit 423ecb
  </head>
Packit 423ecb
  <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 423ecb
    
Packit 423ecb
      
Packit 423ecb
        
Packit 423ecb
          
Packit 423ecb
            Prev
Packit 423ecb
          
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb
          
Packit 423ecb
            Up
Packit 423ecb
          
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb
          
Packit 423ecb
            Home
Packit 423ecb
          
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb
          
Packit 423ecb
            Next
Packit 423ecb
          
Packit 423ecb
        
Packit 423ecb
        libxml2 Reference Manual
Packit 423ecb
      
Packit 423ecb
    
Packit 423ecb
    

Packit 423ecb
      tree
Packit 423ecb
    
Packit 423ecb
    

tree - interfaces for tree manipulation

Packit 423ecb
    

this module describes the structures found in an tree resulting from an XML or HTML parsing, as well as the API provided for various processing on that tree

Packit 423ecb
    

Author(s): Daniel Veillard

Packit 423ecb
    
Packit 423ecb
      

Synopsis

Packit 423ecb
      
#define XML_LOCAL_NAMESPACE;
Packit 423ecb
#define BASE_BUFFER_SIZE;
Packit 423ecb
#define XML_XML_ID;
Packit 423ecb
#define xmlRootNode;
Packit 423ecb
#define XML_GET_LINE;
Packit 423ecb
#define XML_GET_CONTENT;
Packit 423ecb
#define xmlChildrenNode;
Packit 423ecb
#define XML_XML_NAMESPACE;
Packit 423ecb
#define LIBXML2_NEW_BUFFER;
Packit 423ecb
typedef struct _xmlNs xmlNs;
Packit 423ecb
typedef struct _xmlElementContent xmlElementContent;
Packit 423ecb
typedef xmlEnumeration * xmlEnumerationPtr;
Packit 423ecb
typedef struct _xmlBuffer xmlBuffer;
Packit 423ecb
typedef xmlParserInput * xmlParserInputPtr;
Packit 423ecb
typedef xmlSAXLocator * xmlSAXLocatorPtr;
Packit 423ecb
typedef struct _xmlParserInput xmlParserInput;
Packit 423ecb
typedef struct _xmlElement xmlElement;
Packit 423ecb
typedef xmlElementType xmlNsType;
Packit 423ecb
typedef enum xmlBufferAllocationScheme;
Packit 423ecb
typedef struct _xmlNode xmlNode;
Packit 423ecb
typedef xmlDoc * xmlDocPtr;
Packit 423ecb
typedef xmlBuffer * xmlBufferPtr;
Packit 423ecb
typedef xmlDOMWrapCtxt * xmlDOMWrapCtxtPtr;
Packit 423ecb
typedef xmlRef * xmlRefPtr;
Packit 423ecb
typedef struct _xmlParserInputBuffer xmlParserInputBuffer;
Packit 423ecb
typedef struct _xmlRef xmlRef;
Packit 423ecb
typedef struct _xmlDOMWrapCtxt xmlDOMWrapCtxt;
Packit 423ecb
typedef xmlNode * xmlNodePtr;
Packit 423ecb
typedef struct _xmlParserCtxt xmlParserCtxt;
Packit 423ecb
typedef xmlDtd * xmlDtdPtr;
Packit 423ecb
typedef enum xmlAttributeDefault;
Packit 423ecb
typedef struct _xmlBuf xmlBuf;
Packit 423ecb
typedef struct _xmlNotation xmlNotation;
Packit 423ecb
typedef enum xmlElementType;
Packit 423ecb
typedef struct _xmlEntity xmlEntity;
Packit 423ecb
typedef struct _xmlAttr xmlAttr;
Packit 423ecb
typedef xmlAttribute * xmlAttributePtr;
Packit 423ecb
typedef enum xmlElementTypeVal;
Packit 423ecb
typedef xmlNotation * xmlNotationPtr;
Packit 423ecb
typedef xmlElement * xmlElementPtr;
Packit 423ecb
typedef xmlBuf * xmlBufPtr;
Packit 423ecb
typedef enum xmlElementContentOccur;
Packit 423ecb
typedef xmlAttr * xmlAttrPtr;
Packit 423ecb
typedef struct _xmlDoc xmlDoc;
Packit 423ecb
typedef struct _xmlID xmlID;
Packit 423ecb
typedef xmlParserCtxt * xmlParserCtxtPtr;
Packit 423ecb
typedef xmlEntity * xmlEntityPtr;
Packit 423ecb
typedef struct _xmlEnumeration xmlEnumeration;
Packit 423ecb
typedef enum xmlAttributeType;
Packit 423ecb
typedef xmlNs * xmlNsPtr;
Packit 423ecb
typedef xmlParserInputBuffer * xmlParserInputBufferPtr;
Packit 423ecb
typedef struct _xmlSAXHandler xmlSAXHandler;
Packit 423ecb
typedef struct _xmlOutputBuffer xmlOutputBuffer;
Packit 423ecb
typedef struct _xmlSAXLocator xmlSAXLocator;
Packit 423ecb
typedef xmlElementContent * xmlElementContentPtr;
Packit 423ecb
typedef enum xmlElementContentType;
Packit 423ecb
typedef enum xmlDocProperties;
Packit 423ecb
typedef xmlID * xmlIDPtr;
Packit 423ecb
typedef struct _xmlDtd xmlDtd;
Packit 423ecb
typedef struct _xmlAttribute xmlAttribute;
Packit 423ecb
typedef xmlOutputBuffer * xmlOutputBufferPtr;
Packit 423ecb
typedef xmlSAXHandler * xmlSAXHandlerPtr;
Packit 423ecb
xmlNodePtr	xmlDocCopyNode		(xmlNodePtr node, 
xmlDocPtr doc,
int extended);
Packit 423ecb
xmlNodePtr	xmlNewDocRawNode	(xmlDocPtr doc, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content);
Packit 423ecb
xmlChar *	xmlBufContent		(const xmlBuf * buf);
Packit 423ecb
xmlAttrPtr	xmlNewNsPropEatName	(xmlNodePtr node, 
xmlNsPtr ns,
xmlChar * name,
const xmlChar * value);
Packit 423ecb
xmlNodePtr	xmlStringGetNodeList	(const xmlDoc * doc, 
const xmlChar * value);
Packit 423ecb
xmlNodePtr	xmlNewCDataBlock	(xmlDocPtr doc, 
const xmlChar * content,
int len);
Packit 423ecb
void	xmlBufferWriteCHAR		(xmlBufferPtr buf, 
const xmlChar * string);
Packit 423ecb
xmlChar *	xmlNodeGetBase		(const xmlDoc * doc, 
const xmlNode * cur);
Packit 423ecb
void	xmlBufferEmpty			(xmlBufferPtr buf);
Packit 423ecb
xmlChar *	xmlBuildQName		(const xmlChar * ncname, 
const xmlChar * prefix,
xmlChar * memory,
int len);
Packit 423ecb
int	xmlValidateNMToken		(const xmlChar * value, 
int space);
Packit 423ecb
int	xmlSaveFormatFileEnc		(const char * filename, 
xmlDocPtr cur,
const char * encoding,
int format);
Packit 423ecb
xmlNodePtr	xmlAddSibling		(xmlNodePtr cur, 
xmlNodePtr elem);
Packit 423ecb
xmlBufferPtr	xmlBufferCreate		(void);
Packit 423ecb
xmlNodePtr	xmlNewDocFragment	(xmlDocPtr doc);
Packit 423ecb
xmlNodePtr	xmlDocGetRootElement	(const xmlDoc * doc);
Packit 423ecb
xmlChar *	xmlGetProp		(const xmlNode * node, 
const xmlChar * name);
Packit 423ecb
int	xmlValidateName			(const xmlChar * value, 
int space);
Packit 423ecb
xmlChar *	xmlBufEnd		(xmlBufPtr buf);
Packit 423ecb
int	xmlValidateQName		(const xmlChar * value, 
int space);
Packit 423ecb
xmlAttrPtr	xmlHasNsProp		(const xmlNode * node, 
const xmlChar * name,
const xmlChar * nameSpace);
Packit 423ecb
xmlNodePtr	xmlAddPrevSibling	(xmlNodePtr cur, 
xmlNodePtr elem);
Packit 423ecb
int	xmlBufferAddHead		(xmlBufferPtr buf, 
const xmlChar * str,
int len);
Packit 423ecb
xmlNodePtr	xmlNewPI		(const xmlChar * name, 
const xmlChar * content);
Packit 423ecb
void	xmlDocDumpFormatMemoryEnc	(xmlDocPtr out_doc, 
xmlChar ** doc_txt_ptr,
int * doc_txt_len,
const char * txt_encoding,
int format);
Packit 423ecb
xmlAttrPtr	xmlSetProp		(xmlNodePtr node, 
const xmlChar * name,
const xmlChar * value);
Packit 423ecb
unsigned long	xmlChildElementCount	(xmlNodePtr parent);
Packit 423ecb
void	xmlElemDump			(FILE * f, 
xmlDocPtr doc,
xmlNodePtr cur);
Packit 423ecb
int	xmlSaveFormatFileTo		(xmlOutputBufferPtr buf, 
xmlDocPtr cur,
const char * encoding,
int format);
Packit 423ecb
xmlDtdPtr	xmlGetIntSubset		(const xmlDoc * doc);
Packit 423ecb
int	xmlNodeBufGetContent		(xmlBufferPtr buffer, 
const xmlNode * cur);
Packit 423ecb
xmlNodePtr	xmlNextElementSibling	(xmlNodePtr node);
Packit 423ecb
void	xmlBufferWriteChar		(xmlBufferPtr buf, 
const char * string);
Packit 423ecb
void	xmlBufferFree			(xmlBufferPtr buf);
Packit 423ecb
int	xmlDOMWrapCloneNode		(xmlDOMWrapCtxtPtr ctxt, 
xmlDocPtr sourceDoc,
xmlNodePtr node,
xmlNodePtr * resNode,
xmlDocPtr destDoc,
xmlNodePtr destParent,
int deep,
int options);
Packit 423ecb
xmlNodePtr	xmlNewNode		(xmlNsPtr ns, 
const xmlChar * name);
Packit 423ecb
int	xmlSaveFileTo			(xmlOutputBufferPtr buf, 
xmlDocPtr cur,
const char * encoding);
Packit 423ecb
xmlNodePtr	xmlNewTextLen		(const xmlChar * content, 
int len);
Packit 423ecb
xmlNodePtr	xmlNewTextChild		(xmlNodePtr parent, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content);
Packit 423ecb
void	xmlNodeSetContent		(xmlNodePtr cur, 
const xmlChar * content);
Packit 423ecb
int	xmlBufferAdd			(xmlBufferPtr buf, 
const xmlChar * str,
int len);
Packit 423ecb
void	xmlNodeDumpOutput		(xmlOutputBufferPtr buf, 
xmlDocPtr doc,
xmlNodePtr cur,
int level,
int format,
const char * encoding);
Packit 423ecb
xmlNsPtr	xmlCopyNamespace	(xmlNsPtr cur);
Packit 423ecb
xmlNsPtr	xmlSearchNsByHref	(xmlDocPtr doc, 
xmlNodePtr node,
const xmlChar * href);
Packit 423ecb
xmlNodePtr	xmlAddChild		(xmlNodePtr parent, 
xmlNodePtr cur);
Packit 423ecb
int	xmlReconciliateNs		(xmlDocPtr doc, 
xmlNodePtr tree);
Packit 423ecb
int	xmlValidateNCName		(const xmlChar * value, 
int space);
Packit 423ecb
xmlNodePtr	xmlNewDocComment	(xmlDocPtr doc, 
const xmlChar * content);
Packit 423ecb
int	xmlGetCompressMode		(void);
Packit 423ecb
int	xmlNodeDump			(xmlBufferPtr buf, 
xmlDocPtr doc,
xmlNodePtr cur,
int level,
int format);
Packit 423ecb
xmlBufferPtr	xmlBufferCreateSize	(size_t size);
Packit 423ecb
xmlChar *	xmlNodeListGetString	(xmlDocPtr doc, 
const xmlNode * list,
int inLine);
Packit 423ecb
void	xmlSetCompressMode		(int mode);
Packit 423ecb
void	xmlSetTreeDoc			(xmlNodePtr tree, 
xmlDocPtr doc);
Packit 423ecb
int	xmlDOMWrapAdoptNode		(xmlDOMWrapCtxtPtr ctxt, 
xmlDocPtr sourceDoc,
xmlNodePtr node,
xmlDocPtr destDoc,
xmlNodePtr destParent,
int options);
Packit 423ecb
xmlNodePtr	xmlCopyNodeList		(xmlNodePtr node);
Packit 423ecb
xmlNodePtr	xmlNewDocNodeEatName	(xmlDocPtr doc, 
xmlNsPtr ns,
xmlChar * name,
const xmlChar * content);
Packit 423ecb
xmlNodePtr	xmlAddChildList		(xmlNodePtr parent, 
xmlNodePtr cur);
Packit 423ecb
xmlChar *	xmlGetNodePath		(const xmlNode * node);
Packit 423ecb
void	xmlFreePropList			(xmlAttrPtr cur);
Packit 423ecb
void	xmlNodeAddContent		(xmlNodePtr cur, 
const xmlChar * content);
Packit 423ecb
int	xmlUnsetNsProp			(xmlNodePtr node, 
xmlNsPtr ns,
const xmlChar * name);
Packit 423ecb
xmlNodePtr	xmlFirstElementChild	(xmlNodePtr parent);
Packit 423ecb
xmlNodePtr	xmlAddNextSibling	(xmlNodePtr cur, 
xmlNodePtr elem);
Packit 423ecb
int	xmlIsBlankNode			(const xmlNode * node);
Packit 423ecb
xmlNsPtr	xmlNewGlobalNs		(xmlDocPtr doc, 
const xmlChar * href,
const xmlChar * prefix);
Packit 423ecb
int	xmlBufferDump			(FILE * file, 
xmlBufferPtr buf);
Packit 423ecb
xmlChar *	xmlNodeGetContent	(const xmlNode * cur);
Packit 423ecb
xmlDocPtr	xmlCopyDoc		(xmlDocPtr doc, 
int recursive);
Packit 423ecb
xmlDOMWrapCtxtPtr	xmlDOMWrapNewCtxt	(void);
Packit 423ecb
void	xmlDocDumpMemoryEnc		(xmlDocPtr out_doc, 
xmlChar ** doc_txt_ptr,
int * doc_txt_len,
const char * txt_encoding);
Packit 423ecb
int	xmlBufGetNodeContent		(xmlBufPtr buf, 
const xmlNode * cur);
Packit 423ecb
xmlNodePtr	xmlTextMerge		(xmlNodePtr first, 
xmlNodePtr second);
Packit 423ecb
void	xmlDocDumpMemory		(xmlDocPtr cur, 
xmlChar ** mem,
int * size);
Packit 423ecb
xmlNodePtr	xmlNewDocPI		(xmlDocPtr doc, 
const xmlChar * name,
const xmlChar * content);
Packit 423ecb
void	xmlFreeNs			(xmlNsPtr cur);
Packit 423ecb
int	xmlDocDump			(FILE * f, 
xmlDocPtr cur);
Packit 423ecb
void	xmlFreeProp			(xmlAttrPtr cur);
Packit 423ecb
xmlChar *	xmlGetNoNsProp		(const xmlNode * node, 
const xmlChar * name);
Packit 423ecb
xmlChar *	xmlSplitQName2		(const xmlChar * name, 
xmlChar ** prefix);
Packit 423ecb
xmlAttrPtr	xmlNewProp		(xmlNodePtr node, 
const xmlChar * name,
const xmlChar * value);
Packit 423ecb
int	xmlTextConcat			(xmlNodePtr node, 
const xmlChar * content,
int len);
Packit 423ecb
int	xmlNodeGetSpacePreserve		(const xmlNode * cur);
Packit 423ecb
int	xmlBufferShrink			(xmlBufferPtr buf, 
unsigned int len);
Packit 423ecb
xmlNodePtr	xmlPreviousElementSibling	(xmlNodePtr node);
Packit 423ecb
void	xmlNodeSetContentLen		(xmlNodePtr cur, 
const xmlChar * content,
int len);
Packit 423ecb
void	xmlNodeAddContentLen		(xmlNodePtr cur, 
const xmlChar * content,
int len);
Packit 423ecb
void	xmlBufferWriteQuotedString	(xmlBufferPtr buf, 
const xmlChar * string);
Packit 423ecb
xmlAttrPtr	xmlCopyProp		(xmlNodePtr target, 
xmlAttrPtr cur);
Packit 423ecb
xmlNodePtr	xmlReplaceNode		(xmlNodePtr old, 
xmlNodePtr cur);
Packit 423ecb
void	xmlSetDocCompressMode		(xmlDocPtr doc, 
int mode);
Packit 423ecb
xmlNodePtr	xmlCopyNode		(xmlNodePtr node, 
int extended);
Packit 423ecb
void	xmlUnlinkNode			(xmlNodePtr cur);
Packit 423ecb
const xmlChar *	xmlSplitQName3		(const xmlChar * name, 
int * len);
Packit 423ecb
typedef xmlNsPtr xmlDOMWrapAcquireNsFunction	(xmlDOMWrapCtxtPtr ctxt, 
xmlNodePtr node,
const xmlChar * nsName,
const xmlChar * nsPrefix);
Packit 423ecb
size_t	xmlBufUse			(const xmlBufPtr buf);
Packit 423ecb
xmlNodePtr	xmlDocSetRootElement	(xmlDocPtr doc, 
xmlNodePtr root);
Packit 423ecb
long	xmlGetLineNo			(const xmlNode * node);
Packit 423ecb
const xmlChar *	xmlBufferContent	(const xmlBuffer * buf);
Packit 423ecb
int	xmlRemoveProp			(xmlAttrPtr cur);
Packit 423ecb
xmlNodePtr	xmlLastElementChild	(xmlNodePtr parent);
Packit 423ecb
xmlChar *	xmlNodeGetLang		(const xmlNode * cur);
Packit 423ecb
int	xmlGetDocCompressMode		(const xmlDoc * doc);
Packit 423ecb
size_t	xmlBufNodeDump			(xmlBufPtr buf, 
xmlDocPtr doc,
xmlNodePtr cur,
int level,
int format);
Packit 423ecb
xmlChar *	xmlGetNsProp		(const xmlNode * node, 
const xmlChar * name,
const xmlChar * nameSpace);
Packit 423ecb
xmlAttrPtr	xmlNewDocProp		(xmlDocPtr doc, 
const xmlChar * name,
const xmlChar * value);
Packit 423ecb
void	xmlFreeNode			(xmlNodePtr cur);
Packit 423ecb
xmlAttrPtr	xmlNewNsProp		(xmlNodePtr node, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * value);
Packit 423ecb
void	xmlDOMWrapFreeCtxt		(xmlDOMWrapCtxtPtr ctxt);
Packit 423ecb
xmlChar *	xmlBufferDetach		(xmlBufferPtr buf);
Packit 423ecb
void	xmlBufferSetAllocationScheme	(xmlBufferPtr buf, 
xmlBufferAllocationScheme scheme);
Packit 423ecb
xmlNodePtr	xmlNewChild		(xmlNodePtr parent, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content);
Packit 423ecb
xmlNsPtr	xmlSearchNs		(xmlDocPtr doc, 
xmlNodePtr node,
const xmlChar * nameSpace);
Packit 423ecb
xmlNodePtr	xmlStringLenGetNodeList	(const xmlDoc * doc, 
const xmlChar * value,
int len);
Packit 423ecb
int	xmlSaveFormatFile		(const char * filename, 
xmlDocPtr cur,
int format);
Packit 423ecb
xmlAttrPtr	xmlCopyPropList		(xmlNodePtr target, 
xmlAttrPtr cur);
Packit 423ecb
int	xmlDocFormatDump		(FILE * f, 
xmlDocPtr cur,
int format);
Packit 423ecb
void	xmlNodeSetSpacePreserve		(xmlNodePtr cur, 
int val);
Packit 423ecb
xmlAttrPtr	xmlHasProp		(const xmlNode * node, 
const xmlChar * name);
Packit 423ecb
int	xmlBufferCat			(xmlBufferPtr buf, 
const xmlChar * str);
Packit 423ecb
xmlDtdPtr	xmlCreateIntSubset	(xmlDocPtr doc, 
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID);
Packit 423ecb
xmlDocPtr	xmlNewDoc		(const xmlChar * version);
Packit 423ecb
xmlNodePtr	xmlNewCharRef		(xmlDocPtr doc, 
const xmlChar * name);
Packit 423ecb
xmlNsPtr	xmlCopyNamespaceList	(xmlNsPtr cur);
Packit 423ecb
xmlNodePtr	xmlNewNodeEatName	(xmlNsPtr ns, 
xmlChar * name);
Packit 423ecb
int	xmlBufferResize			(xmlBufferPtr buf, 
unsigned int size);
Packit 423ecb
void	xmlNodeSetBase			(xmlNodePtr cur, 
const xmlChar * uri);
Packit 423ecb
xmlNodePtr	xmlNewComment		(const xmlChar * content);
Packit 423ecb
int	xmlBufferLength			(const xmlBuffer * buf);
Packit 423ecb
xmlNodePtr	xmlNewText		(const xmlChar * content);
Packit 423ecb
int	xmlUnsetProp			(xmlNodePtr node, 
const xmlChar * name);
Packit 423ecb
xmlBufferAllocationScheme	xmlGetBufferAllocationScheme	(void);
Packit 423ecb
int	xmlSaveFile			(const char * filename, 
xmlDocPtr cur);
Packit 423ecb
xmlNodePtr	xmlDocCopyNodeList	(xmlDocPtr doc, 
xmlNodePtr node);
Packit 423ecb
void	xmlSetNs			(xmlNodePtr node, 
xmlNsPtr ns);
Packit 423ecb
xmlNsPtr	xmlNewNs		(xmlNodePtr node, 
const xmlChar * href,
const xmlChar * prefix);
Packit 423ecb
int	xmlDOMWrapRemoveNode		(xmlDOMWrapCtxtPtr ctxt, 
xmlDocPtr doc,
xmlNodePtr node,
int options);
Packit 423ecb
void	xmlAttrSerializeTxtContent	(xmlBufferPtr buf, 
xmlDocPtr doc,
xmlAttrPtr attr,
const xmlChar * string);
Packit 423ecb
xmlDtdPtr	xmlCopyDtd		(xmlDtdPtr dtd);
Packit 423ecb
xmlNodePtr	xmlNewDocText		(const xmlDoc * doc, 
const xmlChar * content);
Packit 423ecb
xmlChar *	xmlNodeListGetRawString	(const xmlDoc * doc, 
const xmlNode * list,
int inLine);
Packit 423ecb
xmlBufferPtr	xmlBufferCreateStatic	(void * mem, 
size_t size);
Packit 423ecb
xmlNodePtr	xmlNewReference		(const xmlDoc * doc, 
const xmlChar * name);
Packit 423ecb
int	xmlDOMWrapReconcileNamespaces	(xmlDOMWrapCtxtPtr ctxt, 
xmlNodePtr elem,
int options);
Packit 423ecb
int	xmlBufferCCat			(xmlBufferPtr buf, 
const char * str);
Packit 423ecb
xmlNsPtr *	xmlGetNsList		(const xmlDoc * doc, 
const xmlNode * node);
Packit 423ecb
int	xmlBufferGrow			(xmlBufferPtr buf, 
unsigned int len);
Packit 423ecb
int	xmlNodeIsText			(const xmlNode * node);
Packit 423ecb
void	xmlSetBufferAllocationScheme	(xmlBufferAllocationScheme scheme);
Packit 423ecb
int	xmlIsXHTML			(const xmlChar * systemID, 
const xmlChar * publicID);
Packit 423ecb
void	xmlNodeSetLang			(xmlNodePtr cur, 
const xmlChar * lang);
Packit 423ecb
void	xmlFreeDtd			(xmlDtdPtr cur);
Packit 423ecb
void	xmlFreeNodeList			(xmlNodePtr cur);
Packit 423ecb
void	xmlFreeDoc			(xmlDocPtr cur);
Packit 423ecb
size_t	xmlBufShrink			(xmlBufPtr buf, 
size_t len);
Packit 423ecb
xmlNodePtr	xmlNewDocNode		(xmlDocPtr doc, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content);
Packit 423ecb
int	xmlSaveFileEnc			(const char * filename, 
xmlDocPtr cur,
const char * encoding);
Packit 423ecb
xmlAttrPtr	xmlSetNsProp		(xmlNodePtr node, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * value);
Packit 423ecb
void	xmlDocDumpFormatMemory		(xmlDocPtr cur, 
xmlChar ** mem,
int * size,
int format);
Packit 423ecb
void	xmlSetListDoc			(xmlNodePtr list, 
xmlDocPtr doc);
Packit 423ecb
void	xmlNodeSetName			(xmlNodePtr cur, 
const xmlChar * name);
Packit 423ecb
xmlNodePtr	xmlNewDocTextLen	(xmlDocPtr doc, 
const xmlChar * content,
int len);
Packit 423ecb
xmlDtdPtr	xmlNewDtd		(xmlDocPtr doc, 
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID);
Packit 423ecb
void	xmlFreeNsList			(xmlNsPtr cur);
Packit 423ecb
xmlNodePtr	xmlGetLastChild		(const xmlNode * parent);
Packit 423ecb
Packit 423ecb
    
Packit 423ecb
    
Packit 423ecb
      

Description

Packit 423ecb
    
Packit 423ecb
    
Packit 423ecb
      

Details

Packit 423ecb
      
Packit 423ecb
        

Macro BASE_BUFFER_SIZE

#define BASE_BUFFER_SIZE;
Packit 423ecb

default buffer size 4000.

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Macro LIBXML2_NEW_BUFFER

#define LIBXML2_NEW_BUFFER;
Packit 423ecb

Macro used to express that the API use the new buffers for xmlParserInputBuffer and xmlOutputBuffer. The change was introduced in 2.9.0.

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Macro XML_GET_CONTENT

#define XML_GET_CONTENT;
Packit 423ecb

Macro to extract the content pointer of a node.

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Macro XML_GET_LINE

#define XML_GET_LINE;
Packit 423ecb

Macro to extract the line number of an element node.

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Macro XML_LOCAL_NAMESPACE

#define XML_LOCAL_NAMESPACE;
Packit 423ecb

A namespace declaration node.

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Macro XML_XML_ID

#define XML_XML_ID;
Packit 423ecb

This is the name for the special xml:id attribute

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Macro XML_XML_NAMESPACE

#define XML_XML_NAMESPACE;
Packit 423ecb

This is the namespace for the special xml: prefix predefined in the XML Namespace specification.

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Macro xmlChildrenNode

#define xmlChildrenNode;
Packit 423ecb

Macro for compatibility naming layer with libxml1. Maps to "children."

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Macro xmlRootNode

#define xmlRootNode;
Packit 423ecb

Macro for compatibility naming layer with libxml1. Maps to "children".

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlAttr

struct _xmlAttr {
Packit 423ecb
    void *	_private	: application data
Packit 423ecb
    xmlElementType	type	: XML_ATTRIBUTE_NODE, must be second !
Packit 423ecb
    const xmlChar *	name	: the name of the property
Packit 423ecb
    struct _xmlNode *	children	: the value of the property
Packit 423ecb
    struct _xmlNode *	last	: NULL
Packit 423ecb
    struct _xmlNode *	parent	: child->parent link
Packit 423ecb
    struct _xmlAttr *	next	: next sibling link
Packit 423ecb
    struct _xmlAttr *	prev	: previous sibling link
Packit 423ecb
    struct _xmlDoc *	doc	: the containing document
Packit 423ecb
    xmlNs *	ns	: pointer to the associated namespace
Packit 423ecb
    xmlAttributeType	atype	: the attribute type if validating
Packit 423ecb
    void *	psvi	: for type/PSVI informations
Packit 423ecb
} xmlAttr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlAttrPtr

xmlAttr * xmlAttrPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlAttribute

struct _xmlAttribute {
Packit 423ecb
    void *	_private	: application data
Packit 423ecb
    xmlElementType	type	: XML_ATTRIBUTE_DECL, must be second !
Packit 423ecb
    const xmlChar *	name	: Attribute name
Packit 423ecb
    struct _xmlNode *	children	: NULL
Packit 423ecb
    struct _xmlNode *	last	: NULL
Packit 423ecb
    struct _xmlDtd *	parent	: -> DTD
Packit 423ecb
    struct _xmlNode *	next	: next sibling link
Packit 423ecb
    struct _xmlNode *	prev	: previous sibling link
Packit 423ecb
    struct _xmlDoc *	doc	: the containing document
Packit 423ecb
    struct _xmlAttribute *	nexth	: next in hash table
Packit 423ecb
    xmlAttributeType	atype	: The attribute type
Packit 423ecb
    xmlAttributeDefault	def	: the default
Packit 423ecb
    const xmlChar *	defaultValue	: or the default value
Packit 423ecb
    xmlEnumerationPtr	tree	: or the enumeration tree if any
Packit 423ecb
    const xmlChar *	prefix	: the namespace prefix if any
Packit 423ecb
    const xmlChar *	elem	: Element holding the attribute
Packit 423ecb
} xmlAttribute;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Enum xmlAttributeDefault

enum xmlAttributeDefault {
Packit 423ecb
    XML_ATTRIBUTE_NONE = 1
Packit 423ecb
    XML_ATTRIBUTE_REQUIRED = 2
Packit 423ecb
    XML_ATTRIBUTE_IMPLIED = 3
Packit 423ecb
    XML_ATTRIBUTE_FIXED = 4
Packit 423ecb
};
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlAttributePtr

xmlAttribute * xmlAttributePtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Enum xmlAttributeType

enum xmlAttributeType {
Packit 423ecb
    XML_ATTRIBUTE_CDATA = 1
Packit 423ecb
    XML_ATTRIBUTE_ID = 2
Packit 423ecb
    XML_ATTRIBUTE_IDREF = 3
Packit 423ecb
    XML_ATTRIBUTE_IDREFS = 4
Packit 423ecb
    XML_ATTRIBUTE_ENTITY = 5
Packit 423ecb
    XML_ATTRIBUTE_ENTITIES = 6
Packit 423ecb
    XML_ATTRIBUTE_NMTOKEN = 7
Packit 423ecb
    XML_ATTRIBUTE_NMTOKENS = 8
Packit 423ecb
    XML_ATTRIBUTE_ENUMERATION = 9
Packit 423ecb
    XML_ATTRIBUTE_NOTATION = 10
Packit 423ecb
};
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlBuf

struct _xmlBuf {
Packit 423ecb
The content of this structure is not made public by the API.
Packit 423ecb
} xmlBuf;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlBufPtr

xmlBuf * xmlBufPtr;
Packit 423ecb

A pointer to a buffer structure, the actual structure internals are not public

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlBuffer

struct _xmlBuffer {
Packit 423ecb
    xmlChar *	content	: The buffer content UTF8
Packit 423ecb
    unsigned int	use	: The buffer size used
Packit 423ecb
    unsigned int	size	: The buffer size
Packit 423ecb
    xmlBufferAllocationScheme	alloc	: The realloc method
Packit 423ecb
    xmlChar *	contentIO	: in IO mode we may have a different base
Packit 423ecb
} xmlBuffer;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Enum xmlBufferAllocationScheme

enum xmlBufferAllocationScheme {
Packit 423ecb
    XML_BUFFER_ALLOC_DOUBLEIT = 1 /* double each time one need to grow */
Packit 423ecb
    XML_BUFFER_ALLOC_EXACT = 2 /* grow only to the minimal size */
Packit 423ecb
    XML_BUFFER_ALLOC_IMMUTABLE = 3 /* immutable buffer */
Packit 423ecb
    XML_BUFFER_ALLOC_IO = 4 /* special allocation scheme used for I/O */
Packit 423ecb
    XML_BUFFER_ALLOC_HYBRID = 5 /* exact up to a threshold, and doubleit thereafter */
Packit 423ecb
    XML_BUFFER_ALLOC_BOUNDED = 6 /*  limit the upper size of the buffer */
Packit 423ecb
};
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlBufferPtr

xmlBuffer * xmlBufferPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlDOMWrapCtxt

struct _xmlDOMWrapCtxt {
Packit 423ecb
    void *	_private	: * The type of this context, just in case we need specialized * context
Packit 423ecb
    int	type	: * Internal namespace map used for various operations. *
Packit 423ecb
    void *	namespaceMap	: * Use this one to acquire an xmlNsPtr intended for node->ns. * (Note t
Packit 423ecb
    xmlDOMWrapAcquireNsFunction	getNsForNodeFunc
Packit 423ecb
} xmlDOMWrapCtxt;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlDOMWrapCtxtPtr

xmlDOMWrapCtxt * xmlDOMWrapCtxtPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlDoc

struct _xmlDoc {
Packit 423ecb
    void *	_private	: application data
Packit 423ecb
    xmlElementType	type	: XML_DOCUMENT_NODE, must be second !
Packit 423ecb
    char *	name	: name/filename/URI of the document
Packit 423ecb
    struct _xmlNode *	children	: the document tree
Packit 423ecb
    struct _xmlNode *	last	: last child link
Packit 423ecb
    struct _xmlNode *	parent	: child->parent link
Packit 423ecb
    struct _xmlNode *	next	: next sibling link
Packit 423ecb
    struct _xmlNode *	prev	: previous sibling link
Packit 423ecb
    struct _xmlDoc *	doc	: autoreference to itself End of common part
Packit 423ecb
    int	compression	: level of zlib compression
Packit 423ecb
    int	standalone	: standalone document (no external refs) 1 if standalone="yes" 0 if sta
Packit 423ecb
    struct _xmlDtd *	intSubset	: the document internal subset
Packit 423ecb
    struct _xmlDtd *	extSubset	: the document external subset
Packit 423ecb
    struct _xmlNs *	oldNs	: Global namespace, the old way
Packit 423ecb
    const xmlChar *	version	: the XML version string
Packit 423ecb
    const xmlChar *	encoding	: external initial encoding, if any
Packit 423ecb
    void *	ids	: Hash table for ID attributes if any
Packit 423ecb
    void *	refs	: Hash table for IDREFs attributes if any
Packit 423ecb
    const xmlChar *	URL	: The URI for that document
Packit 423ecb
    int	charset	: encoding of the in-memory content actually an xmlCharEncoding
Packit 423ecb
    struct _xmlDict *	dict	: dict used to allocate names or NULL
Packit 423ecb
    void *	psvi	: for type/PSVI informations
Packit 423ecb
    int	parseFlags	: set of xmlParserOption used to parse the document
Packit 423ecb
    int	properties	: set of xmlDocProperties for this document set at the end of parsing
Packit 423ecb
} xmlDoc;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Enum xmlDocProperties

enum xmlDocProperties {
Packit 423ecb
    XML_DOC_WELLFORMED = 1 /* document is XML well formed */
Packit 423ecb
    XML_DOC_NSVALID = 2 /* document is Namespace valid */
Packit 423ecb
    XML_DOC_OLD10 = 4 /* parsed with old XML-1.0 parser */
Packit 423ecb
    XML_DOC_DTDVALID = 8 /* DTD validation was successful */
Packit 423ecb
    XML_DOC_XINCLUDE = 16 /* XInclude substitution was done */
Packit 423ecb
    XML_DOC_USERBUILT = 32 /* Document was built using the API and not by parsing an instance */
Packit 423ecb
    XML_DOC_INTERNAL = 64 /* built for internal processing */
Packit 423ecb
    XML_DOC_HTML = 128 /*  parsed or built HTML document */
Packit 423ecb
};
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlDocPtr

xmlDoc * xmlDocPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlDtd

struct _xmlDtd {
Packit 423ecb
    void *	_private	: application data
Packit 423ecb
    xmlElementType	type	: XML_DTD_NODE, must be second !
Packit 423ecb
    const xmlChar *	name	: Name of the DTD
Packit 423ecb
    struct _xmlNode *	children	: the value of the property link
Packit 423ecb
    struct _xmlNode *	last	: last child link
Packit 423ecb
    struct _xmlDoc *	parent	: child->parent link
Packit 423ecb
    struct _xmlNode *	next	: next sibling link
Packit 423ecb
    struct _xmlNode *	prev	: previous sibling link
Packit 423ecb
    struct _xmlDoc *	doc	: the containing document End of common part
Packit 423ecb
    void *	notations	: Hash table for notations if any
Packit 423ecb
    void *	elements	: Hash table for elements if any
Packit 423ecb
    void *	attributes	: Hash table for attributes if any
Packit 423ecb
    void *	entities	: Hash table for entities if any
Packit 423ecb
    const xmlChar *	ExternalID	: External identifier for PUBLIC DTD
Packit 423ecb
    const xmlChar *	SystemID	: URI for a SYSTEM or PUBLIC DTD
Packit 423ecb
    void *	pentities	: Hash table for param entities if any
Packit 423ecb
} xmlDtd;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlDtdPtr

xmlDtd * xmlDtdPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlElement

struct _xmlElement {
Packit 423ecb
    void *	_private	: application data
Packit 423ecb
    xmlElementType	type	: XML_ELEMENT_DECL, must be second !
Packit 423ecb
    const xmlChar *	name	: Element name
Packit 423ecb
    struct _xmlNode *	children	: NULL
Packit 423ecb
    struct _xmlNode *	last	: NULL
Packit 423ecb
    struct _xmlDtd *	parent	: -> DTD
Packit 423ecb
    struct _xmlNode *	next	: next sibling link
Packit 423ecb
    struct _xmlNode *	prev	: previous sibling link
Packit 423ecb
    struct _xmlDoc *	doc	: the containing document
Packit 423ecb
    xmlElementTypeVal	etype	: The type
Packit 423ecb
    xmlElementContentPtr	content	: the allowed element content
Packit 423ecb
    xmlAttributePtr	attributes	: List of the declared attributes
Packit 423ecb
    const xmlChar *	prefix	: the namespace prefix if any
Packit 423ecb
    xmlRegexpPtr	contModel	: the validating regexp
Packit 423ecb
    void *	contModel
Packit 423ecb
} xmlElement;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlElementContent

struct _xmlElementContent {
Packit 423ecb
    xmlElementContentType	type	: PCDATA, ELEMENT, SEQ or OR
Packit 423ecb
    xmlElementContentOccur	ocur	: ONCE, OPT, MULT or PLUS
Packit 423ecb
    const xmlChar *	name	: Element name
Packit 423ecb
    struct _xmlElementContent *	c1	: first child
Packit 423ecb
    struct _xmlElementContent *	c2	: second child
Packit 423ecb
    struct _xmlElementContent *	parent	: parent
Packit 423ecb
    const xmlChar *	prefix	: Namespace prefix
Packit 423ecb
} xmlElementContent;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Enum xmlElementContentOccur

enum xmlElementContentOccur {
Packit 423ecb
    XML_ELEMENT_CONTENT_ONCE = 1
Packit 423ecb
    XML_ELEMENT_CONTENT_OPT = 2
Packit 423ecb
    XML_ELEMENT_CONTENT_MULT = 3
Packit 423ecb
    XML_ELEMENT_CONTENT_PLUS = 4
Packit 423ecb
};
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlElementContentPtr

xmlElementContent * xmlElementContentPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Enum xmlElementContentType

enum xmlElementContentType {
Packit 423ecb
    XML_ELEMENT_CONTENT_PCDATA = 1
Packit 423ecb
    XML_ELEMENT_CONTENT_ELEMENT = 2
Packit 423ecb
    XML_ELEMENT_CONTENT_SEQ = 3
Packit 423ecb
    XML_ELEMENT_CONTENT_OR = 4
Packit 423ecb
};
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlElementPtr

xmlElement * xmlElementPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Enum xmlElementType

enum xmlElementType {
Packit 423ecb
    XML_ELEMENT_NODE = 1
Packit 423ecb
    XML_ATTRIBUTE_NODE = 2
Packit 423ecb
    XML_TEXT_NODE = 3
Packit 423ecb
    XML_CDATA_SECTION_NODE = 4
Packit 423ecb
    XML_ENTITY_REF_NODE = 5
Packit 423ecb
    XML_ENTITY_NODE = 6
Packit 423ecb
    XML_PI_NODE = 7
Packit 423ecb
    XML_COMMENT_NODE = 8
Packit 423ecb
    XML_DOCUMENT_NODE = 9
Packit 423ecb
    XML_DOCUMENT_TYPE_NODE = 10
Packit 423ecb
    XML_DOCUMENT_FRAG_NODE = 11
Packit 423ecb
    XML_NOTATION_NODE = 12
Packit 423ecb
    XML_HTML_DOCUMENT_NODE = 13
Packit 423ecb
    XML_DTD_NODE = 14
Packit 423ecb
    XML_ELEMENT_DECL = 15
Packit 423ecb
    XML_ATTRIBUTE_DECL = 16
Packit 423ecb
    XML_ENTITY_DECL = 17
Packit 423ecb
    XML_NAMESPACE_DECL = 18
Packit 423ecb
    XML_XINCLUDE_START = 19
Packit 423ecb
    XML_XINCLUDE_END = 20
Packit 423ecb
    XML_DOCB_DOCUMENT_NODE = 21
Packit 423ecb
};
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Enum xmlElementTypeVal

enum xmlElementTypeVal {
Packit 423ecb
    XML_ELEMENT_TYPE_UNDEFINED = 0
Packit 423ecb
    XML_ELEMENT_TYPE_EMPTY = 1
Packit 423ecb
    XML_ELEMENT_TYPE_ANY = 2
Packit 423ecb
    XML_ELEMENT_TYPE_MIXED = 3
Packit 423ecb
    XML_ELEMENT_TYPE_ELEMENT = 4
Packit 423ecb
};
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlEntity

struct _xmlEntity {
Packit 423ecb
    void *	_private	: application data
Packit 423ecb
    xmlElementType	type	: XML_ENTITY_DECL, must be second !
Packit 423ecb
    const xmlChar *	name	: Entity name
Packit 423ecb
    struct _xmlNode *	children	: First child link
Packit 423ecb
    struct _xmlNode *	last	: Last child link
Packit 423ecb
    struct _xmlDtd *	parent	: -> DTD
Packit 423ecb
    struct _xmlNode *	next	: next sibling link
Packit 423ecb
    struct _xmlNode *	prev	: previous sibling link
Packit 423ecb
    struct _xmlDoc *	doc	: the containing document
Packit 423ecb
    xmlChar *	orig	: content without ref substitution
Packit 423ecb
    xmlChar *	content	: content or ndata if unparsed
Packit 423ecb
    int	length	: the content length
Packit 423ecb
    xmlEntityType	etype	: The entity type
Packit 423ecb
    const xmlChar *	ExternalID	: External identifier for PUBLIC
Packit 423ecb
    const xmlChar *	SystemID	: URI for a SYSTEM or PUBLIC Entity
Packit 423ecb
    struct _xmlEntity *	nexte	: unused
Packit 423ecb
    const xmlChar *	URI	: the full URI as computed
Packit 423ecb
    int	owner	: does the entity own the childrens
Packit 423ecb
    int	checked	: was the entity content checked this is also used to count entities *
Packit 423ecb
} xmlEntity;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlEntityPtr

xmlEntity * xmlEntityPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlEnumeration

struct _xmlEnumeration {
Packit 423ecb
    struct _xmlEnumeration *	next	: next one
Packit 423ecb
    const xmlChar *	name	: Enumeration name
Packit 423ecb
} xmlEnumeration;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlEnumerationPtr

xmlEnumeration * xmlEnumerationPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlID

struct _xmlID {
Packit 423ecb
    struct _xmlID *	next	: next ID
Packit 423ecb
    const xmlChar *	value	: The ID name
Packit 423ecb
    xmlAttrPtr	attr	: The attribute holding it
Packit 423ecb
    const xmlChar *	name	: The attribute if attr is not available
Packit 423ecb
    int	lineno	: The line number if attr is not available
Packit 423ecb
    struct _xmlDoc *	doc	: The document holding the ID
Packit 423ecb
} xmlID;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlIDPtr

xmlID * xmlIDPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlNode

struct _xmlNode {
Packit 423ecb
    void *	_private	: application data
Packit 423ecb
    xmlElementType	type	: type number, must be second !
Packit 423ecb
    const xmlChar *	name	: the name of the node, or the entity
Packit 423ecb
    struct _xmlNode *	children	: parent->childs link
Packit 423ecb
    struct _xmlNode *	last	: last child link
Packit 423ecb
    struct _xmlNode *	parent	: child->parent link
Packit 423ecb
    struct _xmlNode *	next	: next sibling link
Packit 423ecb
    struct _xmlNode *	prev	: previous sibling link
Packit 423ecb
    struct _xmlDoc *	doc	: the containing document End of common part
Packit 423ecb
    xmlNs *	ns	: pointer to the associated namespace
Packit 423ecb
    xmlChar *	content	: the content
Packit 423ecb
    struct _xmlAttr *	properties	: properties list
Packit 423ecb
    xmlNs *	nsDef	: namespace definitions on this node
Packit 423ecb
    void *	psvi	: for type/PSVI informations
Packit 423ecb
    unsigned short	line	: line number
Packit 423ecb
    unsigned short	extra	: extra data for XPath/XSLT
Packit 423ecb
} xmlNode;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlNodePtr

xmlNode * xmlNodePtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlNotation

struct _xmlNotation {
Packit 423ecb
    const xmlChar *	name	: Notation name
Packit 423ecb
    const xmlChar *	PublicID	: Public identifier, if any
Packit 423ecb
    const xmlChar *	SystemID	: System identifier, if any
Packit 423ecb
} xmlNotation;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlNotationPtr

xmlNotation * xmlNotationPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlNs

struct _xmlNs {
Packit 423ecb
    struct _xmlNs *	next	: next Ns link for this node
Packit 423ecb
    xmlNsType	type	: global or local
Packit 423ecb
    const xmlChar *	href	: URL for the namespace
Packit 423ecb
    const xmlChar *	prefix	: prefix for the namespace
Packit 423ecb
    void *	_private	: application data
Packit 423ecb
    struct _xmlDoc *	context	: normally an xmlDoc
Packit 423ecb
} xmlNs;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlNsPtr

xmlNs * xmlNsPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlNsType

xmlElementType xmlNsType;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlOutputBuffer

struct _xmlOutputBuffer {
Packit 423ecb
    void *	context
Packit 423ecb
    xmlOutputWriteCallback	writecallback
Packit 423ecb
    xmlOutputCloseCallback	closecallback
Packit 423ecb
    xmlCharEncodingHandlerPtr	encoder	: I18N conversions to UTF-8
Packit 423ecb
    xmlBufPtr	buffer	: Local buffer encoded in UTF-8 or ISOLatin
Packit 423ecb
    xmlBufPtr	conv	: if encoder != NULL buffer for output
Packit 423ecb
    int	written	: total number of byte written
Packit 423ecb
    int	error
Packit 423ecb
} xmlOutputBuffer;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlOutputBufferPtr

xmlOutputBuffer * xmlOutputBufferPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlParserCtxt

struct _xmlParserCtxt {
Packit 423ecb
    struct _xmlSAXHandler *	sax	: The SAX handler
Packit 423ecb
    void *	userData	: For SAX interface only, used by DOM build
Packit 423ecb
    xmlDocPtr	myDoc	: the document being built
Packit 423ecb
    int	wellFormed	: is the document well formed
Packit 423ecb
    int	replaceEntities	: shall we replace entities ?
Packit 423ecb
    const xmlChar *	version	: the XML version string
Packit 423ecb
    const xmlChar *	encoding	: the declared encoding, if any
Packit 423ecb
    int	standalone	: standalone document
Packit 423ecb
    int	html	: an HTML(1)/Docbook(2) document * 3 is HTML after <head> * 10 is HTML
Packit 423ecb
    xmlParserInputPtr	input	: Current input stream
Packit 423ecb
    int	inputNr	: Number of current input streams
Packit 423ecb
    int	inputMax	: Max number of input streams
Packit 423ecb
    xmlParserInputPtr *	inputTab	: stack of inputs Node analysis stack only used for DOM building
Packit 423ecb
    xmlNodePtr	node	: Current parsed Node
Packit 423ecb
    int	nodeNr	: Depth of the parsing stack
Packit 423ecb
    int	nodeMax	: Max depth of the parsing stack
Packit 423ecb
    xmlNodePtr *	nodeTab	: array of nodes
Packit 423ecb
    int	record_info	: Whether node info should be kept
Packit 423ecb
    xmlParserNodeInfoSeq	node_seq	: info about each node parsed
Packit 423ecb
    int	errNo	: error code
Packit 423ecb
    int	hasExternalSubset	: reference and external subset
Packit 423ecb
    int	hasPErefs	: the internal subset has PE refs
Packit 423ecb
    int	external	: are we parsing an external entity
Packit 423ecb
    int	valid	: is the document valid
Packit 423ecb
    int	validate	: shall we try to validate ?
Packit 423ecb
    xmlValidCtxt	vctxt	: The validity context
Packit 423ecb
    xmlParserInputState	instate	: current type of input
Packit 423ecb
    int	token	: next char look-ahead
Packit 423ecb
    char *	directory	: the data directory Node name stack
Packit 423ecb
    const xmlChar *	name	: Current parsed Node
Packit 423ecb
    int	nameNr	: Depth of the parsing stack
Packit 423ecb
    int	nameMax	: Max depth of the parsing stack
Packit 423ecb
    const xmlChar * *	nameTab	: array of nodes
Packit 423ecb
    long	nbChars	: number of xmlChar processed
Packit 423ecb
    long	checkIndex	: used by progressive parsing lookup
Packit 423ecb
    int	keepBlanks	: ugly but ...
Packit 423ecb
    int	disableSAX	: SAX callbacks are disabled
Packit 423ecb
    int	inSubset	: Parsing is in int 1/ext 2 subset
Packit 423ecb
    const xmlChar *	intSubName	: name of subset
Packit 423ecb
    xmlChar *	extSubURI	: URI of external subset
Packit 423ecb
    xmlChar *	extSubSystem	: SYSTEM ID of external subset xml:space values
Packit 423ecb
    int *	space	: Should the parser preserve spaces
Packit 423ecb
    int	spaceNr	: Depth of the parsing stack
Packit 423ecb
    int	spaceMax	: Max depth of the parsing stack
Packit 423ecb
    int *	spaceTab	: array of space infos
Packit 423ecb
    int	depth	: to prevent entity substitution loops
Packit 423ecb
    xmlParserInputPtr	entity	: used to check entities boundaries
Packit 423ecb
    int	charset	: encoding of the in-memory content actually an xmlCharEncoding
Packit 423ecb
    int	nodelen	: Those two fields are there to
Packit 423ecb
    int	nodemem	: Speed up large node parsing
Packit 423ecb
    int	pedantic	: signal pedantic warnings
Packit 423ecb
    void *	_private	: For user data, libxml won't touch it
Packit 423ecb
    int	loadsubset	: should the external subset be loaded
Packit 423ecb
    int	linenumbers	: set line number in element content
Packit 423ecb
    void *	catalogs	: document's own catalog
Packit 423ecb
    int	recovery	: run in recovery mode
Packit 423ecb
    int	progressive	: is this a progressive parsing
Packit 423ecb
    xmlDictPtr	dict	: dictionary for the parser
Packit 423ecb
    const xmlChar * *	atts	: array for the attributes callbacks
Packit 423ecb
    int	maxatts	: the size of the array
Packit 423ecb
    int	docdict	: * pre-interned strings *
Packit 423ecb
    const xmlChar *	str_xml
Packit 423ecb
    const xmlChar *	str_xmlns
Packit 423ecb
    const xmlChar *	str_xml_ns	: * Everything below is used only by the new SAX mode *
Packit 423ecb
    int	sax2	: operating in the new SAX mode
Packit 423ecb
    int	nsNr	: the number of inherited namespaces
Packit 423ecb
    int	nsMax	: the size of the arrays
Packit 423ecb
    const xmlChar * *	nsTab	: the array of prefix/namespace name
Packit 423ecb
    int *	attallocs	: which attribute were allocated
Packit 423ecb
    void * *	pushTab	: array of data for push
Packit 423ecb
    xmlHashTablePtr	attsDefault	: defaulted attributes if any
Packit 423ecb
    xmlHashTablePtr	attsSpecial	: non-CDATA attributes if any
Packit 423ecb
    int	nsWellFormed	: is the document XML Nanespace okay
Packit 423ecb
    int	options	: * Those fields are needed only for treaming parsing so far *
Packit 423ecb
    int	dictNames	: Use dictionary names for the tree
Packit 423ecb
    int	freeElemsNr	: number of freed element nodes
Packit 423ecb
    xmlNodePtr	freeElems	: List of freed element nodes
Packit 423ecb
    int	freeAttrsNr	: number of freed attributes nodes
Packit 423ecb
    xmlAttrPtr	freeAttrs	: * the complete error informations for the last error. *
Packit 423ecb
    xmlError	lastError
Packit 423ecb
    xmlParserMode	parseMode	: the parser mode
Packit 423ecb
    unsigned long	nbentities	: number of entities references
Packit 423ecb
    unsigned long	sizeentities	: size of parsed entities for use by HTML non-recursive parser
Packit 423ecb
    xmlParserNodeInfo *	nodeInfo	: Current NodeInfo
Packit 423ecb
    int	nodeInfoNr	: Depth of the parsing stack
Packit 423ecb
    int	nodeInfoMax	: Max depth of the parsing stack
Packit 423ecb
    xmlParserNodeInfo *	nodeInfoTab	: array of nodeInfos
Packit 423ecb
    int	input_id	: we need to label inputs
Packit 423ecb
    unsigned long	sizeentcopy	: volume of entity copy
Packit 423ecb
} xmlParserCtxt;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlParserCtxtPtr

xmlParserCtxt * xmlParserCtxtPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlParserInput

struct _xmlParserInput {
Packit 423ecb
    xmlParserInputBufferPtr	buf	: UTF-8 encoded buffer
Packit 423ecb
    const char *	filename	: The file analyzed, if any
Packit 423ecb
    const char *	directory	: the directory/base of the file
Packit 423ecb
    const xmlChar *	base	: Base of the array to parse
Packit 423ecb
    const xmlChar *	cur	: Current char being parsed
Packit 423ecb
    const xmlChar *	end	: end of the array to parse
Packit 423ecb
    int	length	: length if known
Packit 423ecb
    int	line	: Current line
Packit 423ecb
    int	col	: * NOTE: consumed is only tested for equality in the parser code, *
Packit 423ecb
    unsigned long	consumed	: How many xmlChars already consumed
Packit 423ecb
    xmlParserInputDeallocate	free	: function to deallocate the base
Packit 423ecb
    const xmlChar *	encoding	: the encoding string for entity
Packit 423ecb
    const xmlChar *	version	: the version string for entity
Packit 423ecb
    int	standalone	: Was that entity marked standalone
Packit 423ecb
    int	id	: an unique identifier for the entity
Packit 423ecb
} xmlParserInput;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlParserInputBuffer

struct _xmlParserInputBuffer {
Packit 423ecb
    void *	context
Packit 423ecb
    xmlInputReadCallback	readcallback
Packit 423ecb
    xmlInputCloseCallback	closecallback
Packit 423ecb
    xmlCharEncodingHandlerPtr	encoder	: I18N conversions to UTF-8
Packit 423ecb
    xmlBufPtr	buffer	: Local buffer encoded in UTF-8
Packit 423ecb
    xmlBufPtr	raw	: if encoder != NULL buffer for raw input
Packit 423ecb
    int	compressed	: -1=unknown, 0=not compressed, 1=compressed
Packit 423ecb
    int	error
Packit 423ecb
    unsigned long	rawconsumed	: amount consumed from raw
Packit 423ecb
} xmlParserInputBuffer;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlParserInputBufferPtr

xmlParserInputBuffer * xmlParserInputBufferPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlParserInputPtr

xmlParserInput * xmlParserInputPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlRef

struct _xmlRef {
Packit 423ecb
    struct _xmlRef *	next	: next Ref
Packit 423ecb
    const xmlChar *	value	: The Ref name
Packit 423ecb
    xmlAttrPtr	attr	: The attribute holding it
Packit 423ecb
    const xmlChar *	name	: The attribute if attr is not available
Packit 423ecb
    int	lineno	: The line number if attr is not available
Packit 423ecb
} xmlRef;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlRefPtr

xmlRef * xmlRefPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlSAXHandler

struct _xmlSAXHandler {
Packit 423ecb
    internalSubsetSAXFunc	internalSubset
Packit 423ecb
    isStandaloneSAXFunc	isStandalone
Packit 423ecb
    hasInternalSubsetSAXFunc	hasInternalSubset
Packit 423ecb
    hasExternalSubsetSAXFunc	hasExternalSubset
Packit 423ecb
    resolveEntitySAXFunc	resolveEntity
Packit 423ecb
    getEntitySAXFunc	getEntity
Packit 423ecb
    entityDeclSAXFunc	entityDecl
Packit 423ecb
    notationDeclSAXFunc	notationDecl
Packit 423ecb
    attributeDeclSAXFunc	attributeDecl
Packit 423ecb
    elementDeclSAXFunc	elementDecl
Packit 423ecb
    unparsedEntityDeclSAXFunc	unparsedEntityDecl
Packit 423ecb
    setDocumentLocatorSAXFunc	setDocumentLocator
Packit 423ecb
    startDocumentSAXFunc	startDocument
Packit 423ecb
    endDocumentSAXFunc	endDocument
Packit 423ecb
    startElementSAXFunc	startElement
Packit 423ecb
    endElementSAXFunc	endElement
Packit 423ecb
    referenceSAXFunc	reference
Packit 423ecb
    charactersSAXFunc	characters
Packit 423ecb
    ignorableWhitespaceSAXFunc	ignorableWhitespace
Packit 423ecb
    processingInstructionSAXFunc	processingInstruction
Packit 423ecb
    commentSAXFunc	comment
Packit 423ecb
    warningSAXFunc	warning
Packit 423ecb
    errorSAXFunc	error
Packit 423ecb
    fatalErrorSAXFunc	fatalError	: unused error() get all the errors
Packit 423ecb
    getParameterEntitySAXFunc	getParameterEntity
Packit 423ecb
    cdataBlockSAXFunc	cdataBlock
Packit 423ecb
    externalSubsetSAXFunc	externalSubset
Packit 423ecb
    unsigned int	initialized	: The following fields are extensions available only on version 2
Packit 423ecb
    void *	_private
Packit 423ecb
    startElementNsSAX2Func	startElementNs
Packit 423ecb
    endElementNsSAX2Func	endElementNs
Packit 423ecb
    xmlStructuredErrorFunc	serror
Packit 423ecb
} xmlSAXHandler;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlSAXHandlerPtr

xmlSAXHandler * xmlSAXHandlerPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Structure xmlSAXLocator

struct _xmlSAXLocator {
Packit 423ecb
    const xmlChar *(*getPublicId)	getPublicId
Packit 423ecb
    const xmlChar *(*getSystemId)	getSystemId
Packit 423ecb
    int(*getLineNumber)	getLineNumber
Packit 423ecb
    int(*getColumnNumber)	getColumnNumber
Packit 423ecb
} xmlSAXLocator;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Typedef xmlSAXLocatorPtr

xmlSAXLocator * xmlSAXLocatorPtr;
Packit 423ecb

Packit 423ecb
Packit 423ecb
        
Packit 423ecb
        

Function type xmlDOMWrapAcquireNsFunction

xmlNsPtr	xmlDOMWrapAcquireNsFunction	(xmlDOMWrapCtxtPtr ctxt, 
xmlNodePtr node,
const xmlChar * nsName,
const xmlChar * nsPrefix)
Packit 423ecb

A function called to acquire namespaces (xmlNs) from the wrapper.

Packit 423ecb
<tt>ctxt</tt>:a DOM wrapper context
<tt>node</tt>:the context node (element or attribute)
<tt>nsName</tt>:the requested namespace name
<tt>nsPrefix</tt>:the requested namespace prefix
<tt>Returns</tt>:an xmlNsPtr or NULL in case of an error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Add a new node to @parent, at the end of the child (or property) list merging adjacent TEXT nodes (in which case @cur is freed) If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

Packit 423ecb
<tt>parent</tt>:the parent node
<tt>cur</tt>:the child node
<tt>Returns</tt>:the child or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        

xmlAddChildList ()

xmlNodePtr	xmlAddChildList		(xmlNodePtr parent, 
xmlNodePtr cur)
Packit 423ecb

Add a list of node at the end of the child list of the parent merging adjacent TEXT nodes (@cur may be freed)

Packit 423ecb
<tt>parent</tt>:the parent node
<tt>cur</tt>:the first node in the list
<tt>Returns</tt>:the last child or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Add a new node @elem as the next sibling of @cur If the new node was already inserted in a document it is first unlinked from its existing context. As a result of text merging @elem may be freed. If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

Packit 423ecb
<tt>cur</tt>:the child node
<tt>elem</tt>:the new node
<tt>Returns</tt>:the new node or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Add a new node @elem as the previous sibling of @cur merging adjacent TEXT nodes (@elem may be freed) If the new node was already inserted in a document it is first unlinked from its existing context. If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

Packit 423ecb
<tt>cur</tt>:the child node
<tt>elem</tt>:the new node
<tt>Returns</tt>:the new node or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Add a new element @elem to the list of siblings of @cur merging adjacent TEXT nodes (@elem may be freed) If the new element was already inserted in a document it is first unlinked from its existing context.

Packit 423ecb
<tt>cur</tt>:the child node
<tt>elem</tt>:the new node
<tt>Returns</tt>:the new element or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Serialize text attribute values to an xml simple buffer

Packit 423ecb
<tt>buf</tt>:the XML buffer output
<tt>doc</tt>:the document
<tt>attr</tt>:the attribute node
<tt>string</tt>:the text content
Packit 423ecb
        
Packit 423ecb
        

xmlBufContent ()

xmlChar *	xmlBufContent		(const xmlBuf * buf)
Packit 423ecb

Function to extract the content of a buffer

Packit 423ecb
<tt>buf</tt>:the buffer
<tt>Returns</tt>:the internal content
Packit 423ecb
        
Packit 423ecb
        

xmlBufEnd ()

xmlChar *	xmlBufEnd		(xmlBufPtr buf)
Packit 423ecb

Function to extract the end of the content of a buffer

Packit 423ecb
<tt>buf</tt>:the buffer
<tt>Returns</tt>:the end of the internal content or NULL in case of error
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Read the value of a node @cur, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). Entity references are substituted. Fills up the buffer @buf with this value

Packit 423ecb
<tt>buf</tt>:a buffer xmlBufPtr
<tt>cur</tt>:the node being read
<tt>Returns</tt>:0 in case of success and -1 in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML node, recursive behaviour,children are printed too. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Packit 423ecb
<tt>buf</tt>:the XML buffer output
<tt>doc</tt>:the document
<tt>cur</tt>:the current node
<tt>level</tt>:the imbrication level for indenting
<tt>format</tt>:is formatting allowed
<tt>Returns</tt>:the number of bytes written to the buffer, in case of error 0 is returned or @buf stores the error
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Remove the beginning of an XML buffer. NOTE that this routine behaviour differs from xmlBufferShrink() as it will return 0 on error instead of -1 due to size_t being used as the return type.

Packit 423ecb
<tt>buf</tt>:the buffer to dump
<tt>len</tt>:the number of xmlChar to remove
<tt>Returns</tt>:the number of byte removed or 0 in case of failure
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Function to get the length of a buffer

Packit 423ecb
<tt>buf</tt>:the buffer
<tt>Returns</tt>:the length of data in the internal content
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Add a string range to an XML buffer. if len == -1, the length of str is recomputed.

Packit 423ecb
<tt>buf</tt>:the buffer to dump
<tt>str</tt>:the #xmlChar string
<tt>len</tt>:the number of #xmlChar to add
<tt>Returns</tt>:0 successful, a positive error code number otherwise and -1 in case of internal or API error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Add a string range to the beginning of an XML buffer. if len == -1, the length of @str is recomputed.

Packit 423ecb
<tt>buf</tt>:the buffer
<tt>str</tt>:the #xmlChar string
<tt>len</tt>:the number of #xmlChar to add
<tt>Returns</tt>:0 successful, a positive error code number otherwise and -1 in case of internal or API error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Append a zero terminated C string to an XML buffer.

Packit 423ecb
<tt>buf</tt>:the buffer to dump
<tt>str</tt>:the C char string
<tt>Returns</tt>:0 successful, a positive error code number otherwise and -1 in case of internal or API error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Append a zero terminated string to an XML buffer.

Packit 423ecb
<tt>buf</tt>:the buffer to add to
<tt>str</tt>:the #xmlChar string
<tt>Returns</tt>:0 successful, a positive error code number otherwise and -1 in case of internal or API error.
Packit 423ecb
        
Packit 423ecb
        

xmlBufferContent ()

const xmlChar *	xmlBufferContent	(const xmlBuffer * buf)
Packit 423ecb

Function to extract the content of a buffer

Packit 423ecb
<tt>buf</tt>:the buffer
<tt>Returns</tt>:the internal content
Packit 423ecb
        
Packit 423ecb
        

xmlBufferCreate ()

xmlBufferPtr	xmlBufferCreate		(void)
Packit 423ecb

routine to create an XML buffer.

Packit 423ecb
<tt>Returns</tt>:the new structure.
Packit 423ecb
        
Packit 423ecb
        

xmlBufferCreateSize ()

xmlBufferPtr	xmlBufferCreateSize	(size_t size)
Packit 423ecb

routine to create an XML buffer.

Packit 423ecb
<tt>size</tt>:initial size of buffer
<tt>Returns</tt>:the new structure.
Packit 423ecb
        
Packit 423ecb
        

xmlBufferCreateStatic ()

xmlBufferPtr	xmlBufferCreateStatic	(void * mem, 
size_t size)
Packit 423ecb

routine to create an XML buffer from an immutable memory area. The area won't be modified nor copied, and is expected to be present until the end of the buffer lifetime.

Packit 423ecb
<tt>mem</tt>:the memory area
<tt>size</tt>:the size in byte
<tt>Returns</tt>:the new structure.
Packit 423ecb
        
Packit 423ecb
        

xmlBufferDetach ()

xmlChar *	xmlBufferDetach		(xmlBufferPtr buf)
Packit 423ecb

Remove the string contained in a buffer and gie it back to the caller. The buffer is reset to an empty content. This doesn't work with immutable buffers as they can't be reset.

Packit 423ecb
<tt>buf</tt>:the buffer
<tt>Returns</tt>:the previous string contained by the buffer.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dumps an XML buffer to a FILE *.

Packit 423ecb
<tt>file</tt>:the file output
<tt>buf</tt>:the buffer to dump
<tt>Returns</tt>:the number of #xmlChar written
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

empty a buffer.

Packit 423ecb
<tt>buf</tt>:the buffer
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Frees an XML buffer. It frees both the content and the structure which encapsulate it.

Packit 423ecb
<tt>buf</tt>:the buffer to free
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Grow the available space of an XML buffer.

Packit 423ecb
<tt>buf</tt>:the buffer
<tt>len</tt>:the minimum free size to allocate
<tt>Returns</tt>:the new available space or -1 in case of error
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Function to get the length of a buffer

Packit 423ecb
<tt>buf</tt>:the buffer
<tt>Returns</tt>:the length of data in the internal content
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Resize a buffer to accommodate minimum size of @size.

Packit 423ecb
<tt>buf</tt>:the buffer to resize
<tt>size</tt>:the desired size
<tt>Returns</tt>:0 in case of problems, 1 otherwise
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Sets the allocation scheme for this buffer

Packit 423ecb
<tt>buf</tt>:the buffer to tune
<tt>scheme</tt>:allocation scheme to use
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Remove the beginning of an XML buffer.

Packit 423ecb
<tt>buf</tt>:the buffer to dump
<tt>len</tt>:the number of xmlChar to remove
<tt>Returns</tt>:the number of #xmlChar removed, or -1 in case of failure.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

routine which manages and grows an output buffer. This one adds xmlChars at the end of the buffer.

Packit 423ecb
<tt>buf</tt>:the XML buffer
<tt>string</tt>:the string to add
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

routine which manage and grows an output buffer. This one add C chars at the end of the array.

Packit 423ecb
<tt>buf</tt>:the XML buffer output
<tt>string</tt>:the string to add
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

routine which manage and grows an output buffer. This one writes a quoted or double quoted #xmlChar string, checking first if it holds quote or double-quotes internally

Packit 423ecb
<tt>buf</tt>:the XML buffer output
<tt>string</tt>:the string to add
Packit 423ecb
        
Packit 423ecb
        

xmlBuildQName ()

xmlChar *	xmlBuildQName		(const xmlChar * ncname, 
const xmlChar * prefix,
xmlChar * memory,
int len)
Packit 423ecb

Builds the QName @prefix:@ncname in @memory if there is enough space and prefix is not NULL nor empty, otherwise allocate a new string. If prefix is NULL or empty it returns ncname.

Packit 423ecb
<tt>ncname</tt>:the Name
<tt>prefix</tt>:the prefix
<tt>memory</tt>:preallocated memory
<tt>len</tt>:preallocated memory length
<tt>Returns</tt>:the new string which must be freed by the caller if different from @memory and @ncname or NULL in case of error
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Finds the current number of child nodes of that element which are element nodes. Note the handling of entities references is different than in the W3C DOM element traversal spec since we don't have back reference from entities content to entities references.

Packit 423ecb
<tt>parent</tt>:the parent node
<tt>Returns</tt>:the count of element child or 0 if not available
Packit 423ecb
        
Packit 423ecb
        

xmlCopyDoc ()

xmlDocPtr	xmlCopyDoc		(xmlDocPtr doc, 
int recursive)
Packit 423ecb

Do a copy of the document info. If recursive, the content tree will be copied too as well as DTD, namespaces and entities.

Packit 423ecb
<tt>doc</tt>:the document
<tt>recursive</tt>:if not zero do a recursive copy.
<tt>Returns</tt>:a new #xmlDocPtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Do a copy of the dtd.

Packit 423ecb
<tt>dtd</tt>:the dtd
<tt>Returns</tt>:a new #xmlDtdPtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        

xmlCopyNamespace ()

xmlNsPtr	xmlCopyNamespace	(xmlNsPtr cur)
Packit 423ecb

Do a copy of the namespace.

Packit 423ecb
<tt>cur</tt>:the namespace
<tt>Returns</tt>:a new #xmlNsPtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        

xmlCopyNamespaceList ()

xmlNsPtr	xmlCopyNamespaceList	(xmlNsPtr cur)
Packit 423ecb

Do a copy of an namespace list.

Packit 423ecb
<tt>cur</tt>:the first namespace
<tt>Returns</tt>:a new #xmlNsPtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        

xmlCopyNode ()

xmlNodePtr	xmlCopyNode		(xmlNodePtr node, 
int extended)
Packit 423ecb

Do a copy of the node.

Packit 423ecb
<tt>node</tt>:the node
<tt>extended</tt>:if 1 do a recursive copy (properties, namespaces and children when applicable) if 2 copy properties and namespaces (when applicable)
<tt>Returns</tt>:a new #xmlNodePtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Do a recursive copy of the node list. Use xmlDocCopyNodeList() if possible to ensure string interning.

Packit 423ecb
<tt>node</tt>:the first node in the list.
<tt>Returns</tt>:a new #xmlNodePtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Do a copy of the attribute.

Packit 423ecb
<tt>target</tt>:the element where the attribute will be grafted
<tt>cur</tt>:the attribute
<tt>Returns</tt>:a new #xmlAttrPtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        

xmlCopyPropList ()

xmlAttrPtr	xmlCopyPropList		(xmlNodePtr target, 
xmlAttrPtr cur)
Packit 423ecb

Do a copy of an attribute list.

Packit 423ecb
<tt>target</tt>:the element where the attributes will be grafted
<tt>cur</tt>:the first attribute
<tt>Returns</tt>:a new #xmlAttrPtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        

xmlCreateIntSubset ()

xmlDtdPtr	xmlCreateIntSubset	(xmlDocPtr doc, 
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID)
Packit 423ecb

Create the internal subset of a document

Packit 423ecb
<tt>doc</tt>:the document pointer
<tt>name</tt>:the DTD name
<tt>ExternalID</tt>:the external (PUBLIC) ID
<tt>SystemID</tt>:the system ID
<tt>Returns</tt>:a pointer to the new DTD structure
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

References of out-of scope ns-decls are remapped to point to @destDoc: 1) If @destParent is given, then nsDef entries on element-nodes are used 2) If *no* @destParent is given, then @destDoc->oldNs entries are used This is the case when you have an unlinked node and just want to move it to the context of If @destParent is given, it ensures that the tree is namespace wellformed by creating additional ns-decls where needed. Note that, since prefixes of already existent ns-decls can be shadowed by this process, it could break QNames in attribute values or element content. NOTE: This function was not intensively tested.

Packit 423ecb
<tt>ctxt</tt>:the optional context for custom processing
<tt>sourceDoc</tt>:the optional sourceDoc
<tt>node</tt>:the node to start with
<tt>destDoc</tt>:the destination doc
<tt>destParent</tt>:the optional new parent of @node in @destDoc
<tt>options</tt>:option flags
<tt>Returns</tt>:0 if the operation succeeded, 1 if a node of unsupported type was given, 2 if a node of not yet supported type was given and -1 on API/internal errors.
Packit 423ecb
        
Packit 423ecb
        

xmlDOMWrapCloneNode ()

int	xmlDOMWrapCloneNode		(xmlDOMWrapCtxtPtr ctxt, 
xmlDocPtr sourceDoc,
xmlNodePtr node,
xmlNodePtr * resNode,
xmlDocPtr destDoc,
xmlNodePtr destParent,
int deep,
int options)
Packit 423ecb

References of out-of scope ns-decls are remapped to point to @destDoc: 1) If @destParent is given, then nsDef entries on element-nodes are used 2) If *no* @destParent is given, then @destDoc->oldNs entries are used. This is the case when you don't know already where the cloned branch will be added to. If @destParent is given, it ensures that the tree is namespace wellformed by creating additional ns-decls where needed. Note that, since prefixes of already existent ns-decls can be shadowed by this process, it could break QNames in attribute values or element content. TODO: 1) What to do with XInclude? Currently this returns an error for XInclude.

Packit 423ecb
<tt>ctxt</tt>:the optional context for custom processing
<tt>sourceDoc</tt>:the optional sourceDoc
<tt>node</tt>:the node to start with
<tt>resNode</tt>:the clone of the given @node
<tt>destDoc</tt>:the destination doc
<tt>destParent</tt>:the optional new parent of @node in @destDoc
<tt>deep</tt>:descend into child if set
<tt>options</tt>:option flags
<tt>Returns</tt>:0 if the operation succeeded, 1 if a node of unsupported (or not yet supported) type was given, -1 on API/internal errors.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Frees the DOM-wrapper context.

Packit 423ecb
<tt>ctxt</tt>:the DOM-wrapper context
Packit 423ecb
        
Packit 423ecb
        

xmlDOMWrapNewCtxt ()

xmlDOMWrapCtxtPtr	xmlDOMWrapNewCtxt	(void)
Packit 423ecb

Allocates and initializes a new DOM-wrapper context.

Packit 423ecb
<tt>Returns</tt>:the xmlDOMWrapCtxtPtr or NULL in case of an internal error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Ensures that ns-references point to ns-decls hold on element-nodes. Ensures that the tree is namespace wellformed by creating additional ns-decls where needed. Note that, since prefixes of already existent ns-decls can be shadowed by this process, it could break QNames in attribute values or element content. NOTE: This function was not intensively tested.

Packit 423ecb
<tt>ctxt</tt>:DOM wrapper context, unused at the moment
<tt>elem</tt>:the element-node
<tt>options</tt>:option flags
<tt>Returns</tt>:0 if succeeded, -1 otherwise and on API/internal errors.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Unlinks the given node from its owner. This will substitute ns-references to node->nsDef for ns-references to doc->oldNs, thus ensuring the removed branch to be autark wrt ns-references. NOTE: This function was not intensively tested.

Packit 423ecb
<tt>ctxt</tt>:a DOM wrapper context
<tt>doc</tt>:the doc
<tt>node</tt>:the node to be removed.
<tt>options</tt>:set of options, unused at the moment
<tt>Returns</tt>:0 on success, 1 if the node is not supported, -1 on API and internal errors.
Packit 423ecb
        
Packit 423ecb
        

xmlDocCopyNode ()

xmlNodePtr	xmlDocCopyNode		(xmlNodePtr node, 
xmlDocPtr doc,
int extended)
Packit 423ecb

Do a copy of the node to a given document.

Packit 423ecb
<tt>node</tt>:the node
<tt>doc</tt>:the document
<tt>extended</tt>:if 1 do a recursive copy (properties, namespaces and children when applicable) if 2 copy properties and namespaces (when applicable)
<tt>Returns</tt>:a new #xmlNodePtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Do a recursive copy of the node list.

Packit 423ecb
<tt>doc</tt>:the target document
<tt>node</tt>:the first node in the list.
<tt>Returns</tt>:a new #xmlNodePtr, or NULL in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document to an open FILE.

Packit 423ecb
<tt>f</tt>:the FILE*
<tt>cur</tt>:the document
<tt>Returns</tt>:the number of bytes written or -1 in case of failure.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document in memory and return the #xmlChar * and it's size. It's up to the caller to free the memory with xmlFree(). Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Packit 423ecb
<tt>cur</tt>:the document
<tt>mem</tt>:OUT: the memory pointer
<tt>size</tt>:OUT: the memory length
<tt>format</tt>:should formatting spaces been added
Packit 423ecb
        
Packit 423ecb
        

xmlDocDumpFormatMemoryEnc ()

void	xmlDocDumpFormatMemoryEnc	(xmlDocPtr out_doc, 
xmlChar ** doc_txt_ptr,
int * doc_txt_len,
const char * txt_encoding,
int format)
Packit 423ecb

Dump the current DOM tree into memory using the character encoding specified by the caller. Note it is up to the caller of this function to free the allocated memory with xmlFree(). Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Packit 423ecb
<tt>out_doc</tt>:Document to generate XML text from
<tt>doc_txt_ptr</tt>:Memory pointer for allocated XML text
<tt>doc_txt_len</tt>:Length of the generated XML text
<tt>txt_encoding</tt>:Character encoding to use when generating XML text
<tt>format</tt>:should formatting spaces been added
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document in memory and return the #xmlChar * and it's size in bytes. It's up to the caller to free the memory with xmlFree(). The resulting byte array is zero terminated, though the last 0 is not included in the returned size.

Packit 423ecb
<tt>cur</tt>:the document
<tt>mem</tt>:OUT: the memory pointer
<tt>size</tt>:OUT: the memory length
Packit 423ecb
        
Packit 423ecb
        

xmlDocDumpMemoryEnc ()

void	xmlDocDumpMemoryEnc		(xmlDocPtr out_doc, 
xmlChar ** doc_txt_ptr,
int * doc_txt_len,
const char * txt_encoding)
Packit 423ecb

Dump the current DOM tree into memory using the character encoding specified by the caller. Note it is up to the caller of this function to free the allocated memory with xmlFree().

Packit 423ecb
<tt>out_doc</tt>:Document to generate XML text from
<tt>doc_txt_ptr</tt>:Memory pointer for allocated XML text
<tt>doc_txt_len</tt>:Length of the generated XML text
<tt>txt_encoding</tt>:Character encoding to use when generating XML text
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document to an open FILE.

Packit 423ecb
<tt>f</tt>:the FILE*
<tt>cur</tt>:the document
<tt>format</tt>:should formatting spaces been added
<tt>Returns</tt>:the number of bytes written or -1 in case of failure. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called
Packit 423ecb
        
Packit 423ecb
        

xmlDocGetRootElement ()

xmlNodePtr	xmlDocGetRootElement	(const xmlDoc * doc)
Packit 423ecb

Get the root element of the document (doc->children is a list containing possibly comments, PIs, etc ...).

Packit 423ecb
<tt>doc</tt>:the document
<tt>Returns</tt>:the #xmlNodePtr for the root or NULL
Packit 423ecb
        
Packit 423ecb
        

xmlDocSetRootElement ()

xmlNodePtr	xmlDocSetRootElement	(xmlDocPtr doc, 
xmlNodePtr root)
Packit 423ecb

Set the root element of the document (doc->children is a list containing possibly comments, PIs, etc ...).

Packit 423ecb
<tt>doc</tt>:the document
<tt>root</tt>:the new document root element, if root is NULL no action is taken, to remove a node from a document use xmlUnlinkNode(root) instead.
<tt>Returns</tt>:the old root element if any was found, NULL if root was NULL
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML/HTML node, recursive behaviour, children are printed too.

Packit 423ecb
<tt>f</tt>:the FILE * for the output
<tt>doc</tt>:the document
<tt>cur</tt>:the current node
Packit 423ecb
        
Packit 423ecb
        

xmlFirstElementChild ()

xmlNodePtr	xmlFirstElementChild	(xmlNodePtr parent)
Packit 423ecb

Finds the first child node of that element which is a Element node Note the handling of entities references is different than in the W3C DOM element traversal spec since we don't have back reference from entities content to entities references.

Packit 423ecb
<tt>parent</tt>:the parent node
<tt>Returns</tt>:the first element child or NULL if not available
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Free up all the structures used by a document, tree included.

Packit 423ecb
<tt>cur</tt>:pointer to the document
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Free a DTD structure.

Packit 423ecb
<tt>cur</tt>:the DTD structure to free up
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Free a node, this is a recursive behaviour, all the children are freed too. This doesn't unlink the child from the list, use xmlUnlinkNode() first.

Packit 423ecb
<tt>cur</tt>:the node
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Free a node and all its siblings, this is a recursive behaviour, all the children are freed too.

Packit 423ecb
<tt>cur</tt>:the first node in the list
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Free up the structures associated to a namespace

Packit 423ecb
<tt>cur</tt>:the namespace pointer
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Free up all the structures associated to the chained namespaces.

Packit 423ecb
<tt>cur</tt>:the first namespace pointer
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Free one attribute, all the content is freed too

Packit 423ecb
<tt>cur</tt>:an attribute
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Free a property and all its siblings, all the children are freed too.

Packit 423ecb
<tt>cur</tt>:the first property in the list
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, improves performance XML_BUFFER_ALLOC_HYBRID - use exact sizes on small strings to keep memory usage tight in normal usage, and doubleit on large strings to avoid pathological performance.

Packit 423ecb
<tt>Returns</tt>:the current allocation scheme
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

get the default compression mode used, ZLIB based.

Packit 423ecb
<tt>Returns</tt>:0 (uncompressed) to 9 (max compression)
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

get the compression ratio for a document, ZLIB based

Packit 423ecb
<tt>doc</tt>:the document
<tt>Returns</tt>:0 (uncompressed) to 9 (max compression)
Packit 423ecb
        
Packit 423ecb
        

xmlGetIntSubset ()

xmlDtdPtr	xmlGetIntSubset		(const xmlDoc * doc)
Packit 423ecb

Get the internal subset of a document

Packit 423ecb
<tt>doc</tt>:the document pointer
<tt>Returns</tt>:a pointer to the DTD structure or NULL if not found
Packit 423ecb
        
Packit 423ecb
        

xmlGetLastChild ()

xmlNodePtr	xmlGetLastChild		(const xmlNode * parent)
Packit 423ecb

Search the last child of a node.

Packit 423ecb
<tt>parent</tt>:the parent node
<tt>Returns</tt>:the last child or NULL if none.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Get line number of @node. Try to override the limitation of lines being store in 16 bits ints if XML_PARSE_BIG_LINES parser option was used

Packit 423ecb
<tt>node</tt>:valid node
<tt>Returns</tt>:the line number if successful, -1 otherwise
Packit 423ecb
        
Packit 423ecb
        

xmlGetNoNsProp ()

xmlChar *	xmlGetNoNsProp		(const xmlNode * node, 
const xmlChar * name)
Packit 423ecb

Search and get the value of an attribute associated to a node This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off. This function is similar to xmlGetProp except it will accept only an attribute in no namespace.

Packit 423ecb
<tt>node</tt>:the node
<tt>name</tt>:the attribute name
<tt>Returns</tt>:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().
Packit 423ecb
        
Packit 423ecb
        

xmlGetNodePath ()

xmlChar *	xmlGetNodePath		(const xmlNode * node)
Packit 423ecb

Build a structure based Path for the given node

Packit 423ecb
<tt>node</tt>:a node
<tt>Returns</tt>:the new path or NULL in case of error. The caller must free the returned string
Packit 423ecb
        
Packit 423ecb
        

xmlGetNsList ()

xmlNsPtr *	xmlGetNsList		(const xmlDoc * doc, 
const xmlNode * node)
Packit 423ecb

Search all the namespace applying to a given element.

Packit 423ecb
<tt>doc</tt>:the document
<tt>node</tt>:the current node
<tt>Returns</tt>:an NULL terminated array of all the #xmlNsPtr found that need to be freed by the caller or NULL if no namespace if defined
Packit 423ecb
        
Packit 423ecb
        

xmlGetNsProp ()

xmlChar *	xmlGetNsProp		(const xmlNode * node, 
const xmlChar * name,
const xmlChar * nameSpace)
Packit 423ecb

Search and get the value of an attribute associated to a node This attribute has to be anchored in the namespace specified. This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off.

Packit 423ecb
<tt>node</tt>:the node
<tt>name</tt>:the attribute name
<tt>nameSpace</tt>:the URI of the namespace
<tt>Returns</tt>:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().
Packit 423ecb
        
Packit 423ecb
        

xmlGetProp ()

xmlChar *	xmlGetProp		(const xmlNode * node, 
const xmlChar * name)
Packit 423ecb

Search and get the value of an attribute associated to a node This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off. NOTE: this function acts independently of namespaces associated to the attribute. Use xmlGetNsProp() or xmlGetNoNsProp() for namespace aware processing.

Packit 423ecb
<tt>node</tt>:the node
<tt>name</tt>:the attribute name
<tt>Returns</tt>:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().
Packit 423ecb
        
Packit 423ecb
        

xmlHasNsProp ()

xmlAttrPtr	xmlHasNsProp		(const xmlNode * node, 
const xmlChar * name,
const xmlChar * nameSpace)
Packit 423ecb

Search for an attribute associated to a node This attribute has to be anchored in the namespace specified. This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off. Note that a namespace of NULL indicates to use the default namespace.

Packit 423ecb
<tt>node</tt>:the node
<tt>name</tt>:the attribute name
<tt>nameSpace</tt>:the URI of the namespace
<tt>Returns</tt>:the attribute or the attribute declaration or NULL if neither was found.
Packit 423ecb
        
Packit 423ecb
        

xmlHasProp ()

xmlAttrPtr	xmlHasProp		(const xmlNode * node, 
const xmlChar * name)
Packit 423ecb

Search an attribute associated to a node This function also looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off.

Packit 423ecb
<tt>node</tt>:the node
<tt>name</tt>:the attribute name
<tt>Returns</tt>:the attribute or the attribute declaration or NULL if neither was found.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Checks whether this node is an empty or whitespace only (and possibly ignorable) text-node.

Packit 423ecb
<tt>node</tt>:the node
<tt>Returns</tt>:1 yes, 0 no
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Try to find if the document correspond to an XHTML DTD

Packit 423ecb
<tt>systemID</tt>:the system identifier
<tt>publicID</tt>:the public identifier
<tt>Returns</tt>:1 if true, 0 if not and -1 in case of error
Packit 423ecb
        
Packit 423ecb
        

xmlLastElementChild ()

xmlNodePtr	xmlLastElementChild	(xmlNodePtr parent)
Packit 423ecb

Finds the last child node of that element which is a Element node Note the handling of entities references is different than in the W3C DOM element traversal spec since we don't have back reference from entities content to entities references.

Packit 423ecb
<tt>parent</tt>:the parent node
<tt>Returns</tt>:the last element child or NULL if not available
Packit 423ecb
        
Packit 423ecb
        

xmlNewCDataBlock ()

xmlNodePtr	xmlNewCDataBlock	(xmlDocPtr doc, 
const xmlChar * content,
int len)
Packit 423ecb

Creation of a new node containing a CDATA block.

Packit 423ecb
<tt>doc</tt>:the document
<tt>content</tt>:the CDATA block content content
<tt>len</tt>:the length of the block
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewCharRef ()

xmlNodePtr	xmlNewCharRef		(xmlDocPtr doc, 
const xmlChar * name)
Packit 423ecb

Creation of a new character reference node.

Packit 423ecb
<tt>doc</tt>:the document
<tt>name</tt>:the char ref string, starting with # or "&# ... ;"
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewChild ()

xmlNodePtr	xmlNewChild		(xmlNodePtr parent, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content)
Packit 423ecb

Creation of a new child element, added at the end of @parent children list. @ns and @content parameters are optional (NULL). If @ns is NULL, the newly created element inherits the namespace of @parent. If @content is non NULL, a child list containing the TEXTs and ENTITY_REFs node will be created. NOTE: @content is supposed to be a piece of XML CDATA, so it allows entity references. XML special chars must be escaped first by using xmlEncodeEntitiesReentrant(), or xmlNewTextChild() should be used.

Packit 423ecb
<tt>parent</tt>:the parent node
<tt>ns</tt>:a namespace if any
<tt>name</tt>:the name of the child
<tt>content</tt>:the XML content of the child if any.
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewComment ()

xmlNodePtr	xmlNewComment		(const xmlChar * content)
Packit 423ecb

Creation of a new node containing a comment.

Packit 423ecb
<tt>content</tt>:the comment content
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewDoc ()

xmlDocPtr	xmlNewDoc		(const xmlChar * version)
Packit 423ecb

Creates a new XML document

Packit 423ecb
<tt>version</tt>:xmlChar string giving the version of XML "1.0"
<tt>Returns</tt>:a new document
Packit 423ecb
        
Packit 423ecb
        

xmlNewDocComment ()

xmlNodePtr	xmlNewDocComment	(xmlDocPtr doc, 
const xmlChar * content)
Packit 423ecb

Creation of a new node containing a comment within a document.

Packit 423ecb
<tt>doc</tt>:the document
<tt>content</tt>:the comment content
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Creation of a new Fragment node.

Packit 423ecb
<tt>doc</tt>:the document owning the fragment
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewDocNode ()

xmlNodePtr	xmlNewDocNode		(xmlDocPtr doc, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content)
Packit 423ecb

Creation of a new node element within a document. @ns and @content are optional (NULL). NOTE: @content is supposed to be a piece of XML CDATA, so it allow entities references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't need entities support.

Packit 423ecb
<tt>doc</tt>:the document
<tt>ns</tt>:namespace if any
<tt>name</tt>:the node name
<tt>content</tt>:the XML text content if any
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewDocNodeEatName ()

xmlNodePtr	xmlNewDocNodeEatName	(xmlDocPtr doc, 
xmlNsPtr ns,
xmlChar * name,
const xmlChar * content)
Packit 423ecb

Creation of a new node element within a document. @ns and @content are optional (NULL). NOTE: @content is supposed to be a piece of XML CDATA, so it allow entities references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't need entities support.

Packit 423ecb
<tt>doc</tt>:the document
<tt>ns</tt>:namespace if any
<tt>name</tt>:the node name
<tt>content</tt>:the XML text content if any
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewDocPI ()

xmlNodePtr	xmlNewDocPI		(xmlDocPtr doc, 
const xmlChar * name,
const xmlChar * content)
Packit 423ecb

Creation of a processing instruction element.

Packit 423ecb
<tt>doc</tt>:the target document
<tt>name</tt>:the processing instruction name
<tt>content</tt>:the PI content
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewDocProp ()

xmlAttrPtr	xmlNewDocProp		(xmlDocPtr doc, 
const xmlChar * name,
const xmlChar * value)
Packit 423ecb

Create a new property carried by a document.

Packit 423ecb
<tt>doc</tt>:the document
<tt>name</tt>:the name of the attribute
<tt>value</tt>:the value of the attribute
<tt>Returns</tt>:a pointer to the attribute
Packit 423ecb
        
Packit 423ecb
        

xmlNewDocRawNode ()

xmlNodePtr	xmlNewDocRawNode	(xmlDocPtr doc, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content)
Packit 423ecb

Creation of a new node element within a document. @ns and @content are optional (NULL).

Packit 423ecb
<tt>doc</tt>:the document
<tt>ns</tt>:namespace if any
<tt>name</tt>:the node name
<tt>content</tt>:the text content if any
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewDocText ()

xmlNodePtr	xmlNewDocText		(const xmlDoc * doc, 
const xmlChar * content)
Packit 423ecb

Creation of a new text node within a document.

Packit 423ecb
<tt>doc</tt>:the document
<tt>content</tt>:the text content
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewDocTextLen ()

xmlNodePtr	xmlNewDocTextLen	(xmlDocPtr doc, 
const xmlChar * content,
int len)
Packit 423ecb

Creation of a new text node with an extra content length parameter. The text node pertain to a given document.

Packit 423ecb
<tt>doc</tt>:the document
<tt>content</tt>:the text content
<tt>len</tt>:the text len.
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewDtd ()

xmlDtdPtr	xmlNewDtd		(xmlDocPtr doc, 
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID)
Packit 423ecb

Creation of a new DTD for the external subset. To create an internal subset, use xmlCreateIntSubset().

Packit 423ecb
<tt>doc</tt>:the document pointer
<tt>name</tt>:the DTD name
<tt>ExternalID</tt>:the external ID
<tt>SystemID</tt>:the system ID
<tt>Returns</tt>:a pointer to the new DTD structure
Packit 423ecb
        
Packit 423ecb
        

xmlNewGlobalNs ()

xmlNsPtr	xmlNewGlobalNs		(xmlDocPtr doc, 
const xmlChar * href,
const xmlChar * prefix)
Packit 423ecb

Creation of a Namespace, the old way using PI and without scoping DEPRECATED !!!

Packit 423ecb
<tt>doc</tt>:the document carrying the namespace
<tt>href</tt>:the URI associated
<tt>prefix</tt>:the prefix for the namespace
<tt>Returns</tt>:NULL this functionality had been removed
Packit 423ecb
        
Packit 423ecb
        

xmlNewNode ()

xmlNodePtr	xmlNewNode		(xmlNsPtr ns, 
const xmlChar * name)
Packit 423ecb

Creation of a new node element. @ns is optional (NULL).

Packit 423ecb
<tt>ns</tt>:namespace if any
<tt>name</tt>:the node name
<tt>Returns</tt>:a pointer to the new node object. Uses xmlStrdup() to make copy of @name.
Packit 423ecb
        
Packit 423ecb
        

xmlNewNodeEatName ()

xmlNodePtr	xmlNewNodeEatName	(xmlNsPtr ns, 
xmlChar * name)
Packit 423ecb

Creation of a new node element. @ns is optional (NULL).

Packit 423ecb
<tt>ns</tt>:namespace if any
<tt>name</tt>:the node name
<tt>Returns</tt>:a pointer to the new node object, with pointer @name as new node's name. Use xmlNewNode() if a copy of @name string is is needed as new node's name.
Packit 423ecb
        
Packit 423ecb
        

xmlNewNs ()

xmlNsPtr	xmlNewNs		(xmlNodePtr node, 
const xmlChar * href,
const xmlChar * prefix)
Packit 423ecb

Creation of a new Namespace. This function will refuse to create a namespace with a similar prefix than an existing one present on this node. Note that for a default namespace, @prefix should be NULL. We use href==NULL in the case of an element creation where the namespace was not defined.

Packit 423ecb
<tt>node</tt>:the element carrying the namespace
<tt>href</tt>:the URI associated
<tt>prefix</tt>:the prefix for the namespace
<tt>Returns</tt>:a new namespace pointer or NULL
Packit 423ecb
        
Packit 423ecb
        

xmlNewNsProp ()

xmlAttrPtr	xmlNewNsProp		(xmlNodePtr node, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * value)
Packit 423ecb

Create a new property tagged with a namespace and carried by a node.

Packit 423ecb
<tt>node</tt>:the holding node
<tt>ns</tt>:the namespace
<tt>name</tt>:the name of the attribute
<tt>value</tt>:the value of the attribute
<tt>Returns</tt>:a pointer to the attribute
Packit 423ecb
        
Packit 423ecb
        

xmlNewNsPropEatName ()

xmlAttrPtr	xmlNewNsPropEatName	(xmlNodePtr node, 
xmlNsPtr ns,
xmlChar * name,
const xmlChar * value)
Packit 423ecb

Create a new property tagged with a namespace and carried by a node.

Packit 423ecb
<tt>node</tt>:the holding node
<tt>ns</tt>:the namespace
<tt>name</tt>:the name of the attribute
<tt>value</tt>:the value of the attribute
<tt>Returns</tt>:a pointer to the attribute
Packit 423ecb
        
Packit 423ecb
        

xmlNewPI ()

xmlNodePtr	xmlNewPI		(const xmlChar * name, 
const xmlChar * content)
Packit 423ecb

Creation of a processing instruction element. Use xmlDocNewPI preferably to get string interning

Packit 423ecb
<tt>name</tt>:the processing instruction name
<tt>content</tt>:the PI content
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewProp ()

xmlAttrPtr	xmlNewProp		(xmlNodePtr node, 
const xmlChar * name,
const xmlChar * value)
Packit 423ecb

Create a new property carried by a node.

Packit 423ecb
<tt>node</tt>:the holding node
<tt>name</tt>:the name of the attribute
<tt>value</tt>:the value of the attribute
<tt>Returns</tt>:a pointer to the attribute
Packit 423ecb
        
Packit 423ecb
        

xmlNewReference ()

xmlNodePtr	xmlNewReference		(const xmlDoc * doc, 
const xmlChar * name)
Packit 423ecb

Creation of a new reference node.

Packit 423ecb
<tt>doc</tt>:the document
<tt>name</tt>:the reference name, or the reference string with & and ;
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewText ()

xmlNodePtr	xmlNewText		(const xmlChar * content)
Packit 423ecb

Creation of a new text node.

Packit 423ecb
<tt>content</tt>:the text content
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewTextChild ()

xmlNodePtr	xmlNewTextChild		(xmlNodePtr parent, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * content)
Packit 423ecb

Creation of a new child element, added at the end of @parent children list. @ns and @content parameters are optional (NULL). If @ns is NULL, the newly created element inherits the namespace of @parent. If @content is non NULL, a child TEXT node will be created containing the string @content. NOTE: Use xmlNewChild() if @content will contain entities that need to be preserved. Use this function, xmlNewTextChild(), if you need to ensure that reserved XML chars that might appear in @content, such as the ampersand, greater-than or less-than signs, are automatically replaced by their XML escaped entity representations.

Packit 423ecb
<tt>parent</tt>:the parent node
<tt>ns</tt>:a namespace if any
<tt>name</tt>:the name of the child
<tt>content</tt>:the text content of the child if any.
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNewTextLen ()

xmlNodePtr	xmlNewTextLen		(const xmlChar * content, 
int len)
Packit 423ecb

Creation of a new text node with an extra parameter for the content's length

Packit 423ecb
<tt>content</tt>:the text content
<tt>len</tt>:the text len.
<tt>Returns</tt>:a pointer to the new node object.
Packit 423ecb
        
Packit 423ecb
        

xmlNextElementSibling ()

xmlNodePtr	xmlNextElementSibling	(xmlNodePtr node)
Packit 423ecb

Finds the first closest next sibling of the node which is an element node. Note the handling of entities references is different than in the W3C DOM element traversal spec since we don't have back reference from entities content to entities references.

Packit 423ecb
<tt>node</tt>:the current node
<tt>Returns</tt>:the next element sibling or NULL if not available
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Append the extra substring to the node content. NOTE: In contrast to xmlNodeSetContent(), @content is supposed to be raw text, so unescaped XML special chars are allowed, entity references are not supported.

Packit 423ecb
<tt>cur</tt>:the node being modified
<tt>content</tt>:extra content
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Append the extra substring to the node content. NOTE: In contrast to xmlNodeSetContentLen(), @content is supposed to be raw text, so unescaped XML special chars are allowed, entity references are not supported.

Packit 423ecb
<tt>cur</tt>:the node being modified
<tt>content</tt>:extra content
<tt>len</tt>:the size of @content
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Read the value of a node @cur, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). Entity references are substituted. Fills up the buffer @buffer with this value

Packit 423ecb
<tt>buffer</tt>:a buffer
<tt>cur</tt>:the node being read
<tt>Returns</tt>:0 in case of success and -1 in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML node, recursive behaviour,children are printed too. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called Since this is using xmlBuffer structures it is limited to 2GB and somehow deprecated, use xmlBufNodeDump() instead.

Packit 423ecb
<tt>buf</tt>:the XML buffer output
<tt>doc</tt>:the document
<tt>cur</tt>:the current node
<tt>level</tt>:the imbrication level for indenting
<tt>format</tt>:is formatting allowed
<tt>Returns</tt>:the number of bytes written to the buffer or -1 in case of error
Packit 423ecb
        
Packit 423ecb
        

xmlNodeDumpOutput ()

void	xmlNodeDumpOutput		(xmlOutputBufferPtr buf, 
xmlDocPtr doc,
xmlNodePtr cur,
int level,
int format,
const char * encoding)
Packit 423ecb

Dump an XML node, recursive behaviour, children are printed too. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Packit 423ecb
<tt>buf</tt>:the XML buffer output
<tt>doc</tt>:the document
<tt>cur</tt>:the current node
<tt>level</tt>:the imbrication level for indenting
<tt>format</tt>:is formatting allowed
<tt>encoding</tt>:an optional encoding string
Packit 423ecb
        
Packit 423ecb
        

xmlNodeGetBase ()

xmlChar *	xmlNodeGetBase		(const xmlDoc * doc, 
const xmlNode * cur)
Packit 423ecb

Searches for the BASE URL. The code should work on both XML and HTML document even if base mechanisms are completely different. It returns the base as defined in RFC 2396 sections 5.1.1. Base URI within Document Content and 5.1.2. Base URI from the Encapsulating Entity However it does not return the document base (5.1.3), use doc->URL in this case

Packit 423ecb
<tt>doc</tt>:the document the node pertains to
<tt>cur</tt>:the node being checked
<tt>Returns</tt>:a pointer to the base URL, or NULL if not found It's up to the caller to free the memory with xmlFree().
Packit 423ecb
        
Packit 423ecb
        

xmlNodeGetContent ()

xmlChar *	xmlNodeGetContent	(const xmlNode * cur)
Packit 423ecb

Read the value of a node, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). Entity references are substituted.

Packit 423ecb
<tt>cur</tt>:the node being read
<tt>Returns</tt>:a new #xmlChar * or NULL if no content is available. It's up to the caller to free the memory with xmlFree().
Packit 423ecb
        
Packit 423ecb
        

xmlNodeGetLang ()

xmlChar *	xmlNodeGetLang		(const xmlNode * cur)
Packit 423ecb

Searches the language of a node, i.e. the values of the xml:lang attribute or the one carried by the nearest ancestor.

Packit 423ecb
<tt>cur</tt>:the node being checked
<tt>Returns</tt>:a pointer to the lang value, or NULL if not found It's up to the caller to free the memory with xmlFree().
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Searches the space preserving behaviour of a node, i.e. the values of the xml:space attribute or the one carried by the nearest ancestor.

Packit 423ecb
<tt>cur</tt>:the node being checked
<tt>Returns</tt>:-1 if xml:space is not inherited, 0 if "default", 1 if "preserve"
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Is this node a Text node ?

Packit 423ecb
<tt>node</tt>:the node
<tt>Returns</tt>:1 yes, 0 no
Packit 423ecb
        
Packit 423ecb
        

xmlNodeListGetRawString ()

xmlChar *	xmlNodeListGetRawString	(const xmlDoc * doc, 
const xmlNode * list,
int inLine)
Packit 423ecb

Builds the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs, contrary to xmlNodeListGetString() this function doesn't do any character encoding handling.

Packit 423ecb
<tt>doc</tt>:the document
<tt>list</tt>:a Node list
<tt>inLine</tt>:should we replace entity contents or show their external form
<tt>Returns</tt>:a pointer to the string copy, the caller must free it with xmlFree().
Packit 423ecb
        
Packit 423ecb
        

xmlNodeListGetString ()

xmlChar *	xmlNodeListGetString	(xmlDocPtr doc, 
const xmlNode * list,
int inLine)
Packit 423ecb

Build the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs

Packit 423ecb
<tt>doc</tt>:the document
<tt>list</tt>:a Node list
<tt>inLine</tt>:should we replace entity contents or show their external form
<tt>Returns</tt>:a pointer to the string copy, the caller must free it with xmlFree().
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Set (or reset) the base URI of a node, i.e. the value of the xml:base attribute.

Packit 423ecb
<tt>cur</tt>:the node being changed
<tt>uri</tt>:the new base URI
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Replace the content of a node. NOTE: @content is supposed to be a piece of XML CDATA, so it allows entity references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant() resp. xmlEncodeSpecialChars().

Packit 423ecb
<tt>cur</tt>:the node being modified
<tt>content</tt>:the new value of the content
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Replace the content of a node. NOTE: @content is supposed to be a piece of XML CDATA, so it allows entity references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant() resp. xmlEncodeSpecialChars().

Packit 423ecb
<tt>cur</tt>:the node being modified
<tt>content</tt>:the new value of the content
<tt>len</tt>:the size of @content
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Set the language of a node, i.e. the values of the xml:lang attribute.

Packit 423ecb
<tt>cur</tt>:the node being changed
<tt>lang</tt>:the language description
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Set (or reset) the name of a node.

Packit 423ecb
<tt>cur</tt>:the node being changed
<tt>name</tt>:the new tag name
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Set (or reset) the space preserving behaviour of a node, i.e. the value of the xml:space attribute.

Packit 423ecb
<tt>cur</tt>:the node being changed
<tt>val</tt>:the xml:space value ("0": default, 1: "preserve")
Packit 423ecb
        
Packit 423ecb
        

xmlPreviousElementSibling ()

xmlNodePtr	xmlPreviousElementSibling	(xmlNodePtr node)
Packit 423ecb

Finds the first closest previous sibling of the node which is an element node. Note the handling of entities references is different than in the W3C DOM element traversal spec since we don't have back reference from entities content to entities references.

Packit 423ecb
<tt>node</tt>:the current node
<tt>Returns</tt>:the previous element sibling or NULL if not available
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

This function checks that all the namespaces declared within the given tree are properly declared. This is needed for example after Copy or Cut and then paste operations. The subtree may still hold pointers to namespace declarations outside the subtree or invalid/masked. As much as possible the function try to reuse the existing namespaces found in the new environment. If not possible the new namespaces are redeclared on @tree at the top of the given subtree.

Packit 423ecb
<tt>doc</tt>:the document
<tt>tree</tt>:a node defining the subtree to reconciliate
<tt>Returns</tt>:the number of namespace declarations created or -1 in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Unlink and free one attribute, all the content is freed too Note this doesn't work for namespace definition attributes

Packit 423ecb
<tt>cur</tt>:an attribute
<tt>Returns</tt>:0 if success and -1 in case of error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Unlink the old node from its current context, prune the new one at the same place. If @cur was already inserted in a document it is first unlinked from its existing context.

Packit 423ecb
<tt>old</tt>:the old node
<tt>cur</tt>:the node
<tt>Returns</tt>:the @old node
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used.

Packit 423ecb
<tt>filename</tt>:the filename (or URL)
<tt>cur</tt>:the document
<tt>Returns</tt>:the number of bytes written or -1 in case of failure.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document, converting it to the given encoding

Packit 423ecb
<tt>filename</tt>:the filename (or URL)
<tt>cur</tt>:the document
<tt>encoding</tt>:the name of an encoding (or NULL)
<tt>Returns</tt>:the number of bytes written or -1 in case of failure.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document to an I/O buffer. Warning ! This call xmlOutputBufferClose() on buf which is not available after this call.

Packit 423ecb
<tt>buf</tt>:an output I/O buffer
<tt>cur</tt>:the document
<tt>encoding</tt>:the encoding if any assuming the I/O layer handles the trancoding
<tt>Returns</tt>:the number of bytes written or -1 in case of failure.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used. If @format is set then the document will be indented on output. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

Packit 423ecb
<tt>filename</tt>:the filename (or URL)
<tt>cur</tt>:the document
<tt>format</tt>:should formatting spaces been added
<tt>Returns</tt>:the number of bytes written or -1 in case of failure.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document to a file or an URL.

Packit 423ecb
<tt>filename</tt>:the filename or URL to output
<tt>cur</tt>:the document being saved
<tt>encoding</tt>:the name of the encoding to use or NULL.
<tt>format</tt>:should formatting spaces be added.
<tt>Returns</tt>:the number of bytes written or -1 in case of error. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Dump an XML document to an I/O buffer. Warning ! This call xmlOutputBufferClose() on buf which is not available after this call.

Packit 423ecb
<tt>buf</tt>:an output I/O buffer
<tt>cur</tt>:the document
<tt>encoding</tt>:the encoding if any assuming the I/O layer handles the trancoding
<tt>format</tt>:should formatting spaces been added
<tt>Returns</tt>:the number of bytes written or -1 in case of failure.
Packit 423ecb
        
Packit 423ecb
        

xmlSearchNs ()

xmlNsPtr	xmlSearchNs		(xmlDocPtr doc, 
xmlNodePtr node,
const xmlChar * nameSpace)
Packit 423ecb

Search a Ns registered under a given name space for a document. recurse on the parents until it finds the defined namespace or return NULL otherwise. @nameSpace can be NULL, this is a search for the default namespace. We don't allow to cross entities boundaries. If you don't declare the namespace within those you will be in troubles !!! A warning is generated to cover this case.

Packit 423ecb
<tt>doc</tt>:the document
<tt>node</tt>:the current node
<tt>nameSpace</tt>:the namespace prefix
<tt>Returns</tt>:the namespace pointer or NULL.
Packit 423ecb
        
Packit 423ecb
        

xmlSearchNsByHref ()

xmlNsPtr	xmlSearchNsByHref	(xmlDocPtr doc, 
xmlNodePtr node,
const xmlChar * href)
Packit 423ecb

Search a Ns aliasing a given URI. Recurse on the parents until it finds the defined namespace or return NULL otherwise.

Packit 423ecb
<tt>doc</tt>:the document
<tt>node</tt>:the current node
<tt>href</tt>:the namespace value
<tt>Returns</tt>:the namespace pointer or NULL.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Set the buffer allocation method. Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, improves performance

Packit 423ecb
<tt>scheme</tt>:allocation method to use
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

set the default compression mode used, ZLIB based Correct values: 0 (uncompressed) to 9 (max compression)

Packit 423ecb
<tt>mode</tt>:the compression ratio
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

set the compression ratio for a document, ZLIB based Correct values: 0 (uncompressed) to 9 (max compression)

Packit 423ecb
<tt>doc</tt>:the document
<tt>mode</tt>:the compression ratio
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

update all nodes in the list to point to the right document

Packit 423ecb
<tt>list</tt>:the first element
<tt>doc</tt>:the document
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Associate a namespace to a node, a posteriori.

Packit 423ecb
<tt>node</tt>:a node in the document
<tt>ns</tt>:a namespace pointer
Packit 423ecb
        
Packit 423ecb
        

xmlSetNsProp ()

xmlAttrPtr	xmlSetNsProp		(xmlNodePtr node, 
xmlNsPtr ns,
const xmlChar * name,
const xmlChar * value)
Packit 423ecb

Set (or reset) an attribute carried by a node. The ns structure must be in scope, this is not checked

Packit 423ecb
<tt>node</tt>:the node
<tt>ns</tt>:the namespace definition
<tt>name</tt>:the attribute name
<tt>value</tt>:the attribute value
<tt>Returns</tt>:the attribute pointer.
Packit 423ecb
        
Packit 423ecb
        

xmlSetProp ()

xmlAttrPtr	xmlSetProp		(xmlNodePtr node, 
const xmlChar * name,
const xmlChar * value)
Packit 423ecb

Set (or reset) an attribute carried by a node. If @name has a prefix, then the corresponding namespace-binding will be used, if in scope; it is an error it there's no such ns-binding for the prefix in scope.

Packit 423ecb
<tt>node</tt>:the node
<tt>name</tt>:the attribute name (a QName)
<tt>value</tt>:the attribute value
<tt>Returns</tt>:the attribute pointer.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

update all nodes under the tree to point to the right document

Packit 423ecb
<tt>tree</tt>:the top element
<tt>doc</tt>:the document
Packit 423ecb
        
Packit 423ecb
        

xmlSplitQName2 ()

xmlChar *	xmlSplitQName2		(const xmlChar * name, 
xmlChar ** prefix)
Packit 423ecb

parse an XML qualified name string [NS 5] QName ::= (Prefix ':')? LocalPart [NS 6] Prefix ::= NCName [NS 7] LocalPart ::= NCName

Packit 423ecb
<tt>name</tt>:the full QName
<tt>prefix</tt>:a xmlChar **
<tt>Returns</tt>:NULL if the name doesn't have a prefix. Otherwise, returns the local part, and prefix is updated to get the Prefix. Both the return value and the prefix must be freed by the caller.
Packit 423ecb
        
Packit 423ecb
        

xmlSplitQName3 ()

const xmlChar *	xmlSplitQName3		(const xmlChar * name, 
int * len)
Packit 423ecb

parse an XML qualified name string,i

Packit 423ecb
<tt>name</tt>:the full QName
<tt>len</tt>:an int *
<tt>Returns</tt>:NULL if it is not a Qualified Name, otherwise, update len with the length in byte of the prefix and return a pointer to the start of the name without the prefix
Packit 423ecb
        
Packit 423ecb
        

xmlStringGetNodeList ()

xmlNodePtr	xmlStringGetNodeList	(const xmlDoc * doc, 
const xmlChar * value)
Packit 423ecb

Parse the value string and build the node list associated. Should produce a flat tree with only TEXTs and ENTITY_REFs.

Packit 423ecb
<tt>doc</tt>:the document
<tt>value</tt>:the value of the attribute
<tt>Returns</tt>:a pointer to the first child
Packit 423ecb
        
Packit 423ecb
        

xmlStringLenGetNodeList ()

xmlNodePtr	xmlStringLenGetNodeList	(const xmlDoc * doc, 
const xmlChar * value,
int len)
Packit 423ecb

Parse the value string and build the node list associated. Should produce a flat tree with only TEXTs and ENTITY_REFs.

Packit 423ecb
<tt>doc</tt>:the document
<tt>value</tt>:the value of the text
<tt>len</tt>:the length of the string value
<tt>Returns</tt>:a pointer to the first child
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Concat the given string at the end of the existing node content

Packit 423ecb
<tt>node</tt>:the node
<tt>content</tt>:the content
<tt>len</tt>:@content length
<tt>Returns</tt>:-1 in case of error, 0 otherwise
Packit 423ecb
        
Packit 423ecb
        

xmlTextMerge ()

xmlNodePtr	xmlTextMerge		(xmlNodePtr first, 
xmlNodePtr second)
Packit 423ecb

Merge two text nodes into one

Packit 423ecb
<tt>first</tt>:the first text node
<tt>second</tt>:the second text node being merged
<tt>Returns</tt>:the first text node augmented
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Unlink a node from it's current context, the node is not freed If one need to free the node, use xmlFreeNode() routine after the unlink to discard it. Note that namespace nodes can't be unlinked as they do not have pointer to their parent.

Packit 423ecb
<tt>cur</tt>:the node
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Remove an attribute carried by a node.

Packit 423ecb
<tt>node</tt>:the node
<tt>ns</tt>:the namespace definition
<tt>name</tt>:the attribute name
<tt>Returns</tt>:0 if successful, -1 if not found
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Remove an attribute carried by a node. This handles only attributes in no namespace.

Packit 423ecb
<tt>node</tt>:the node
<tt>name</tt>:the attribute name
<tt>Returns</tt>:0 if successful, -1 if not found
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Check that a value conforms to the lexical space of NCName

Packit 423ecb
<tt>value</tt>:the value to check
<tt>space</tt>:allow spaces in front and end of the string
<tt>Returns</tt>:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Check that a value conforms to the lexical space of NMToken

Packit 423ecb
<tt>value</tt>:the value to check
<tt>space</tt>:allow spaces in front and end of the string
<tt>Returns</tt>:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Check that a value conforms to the lexical space of Name

Packit 423ecb
<tt>value</tt>:the value to check
<tt>space</tt>:allow spaces in front and end of the string
<tt>Returns</tt>:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Packit 423ecb
        
Packit 423ecb
        
Packit 423ecb

Check that a value conforms to the lexical space of QName

Packit 423ecb
<tt>value</tt>:the value to check
<tt>space</tt>:allow spaces in front and end of the string
<tt>Returns</tt>:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Packit 423ecb
        
Packit 423ecb
      
Packit 423ecb
    
Packit 423ecb
  </body>
Packit 423ecb
</html>