tree

Gnome XML Library Reference Manual
<<< Previous Page	Home	Up	Next Page >>>

Details

enum xmlElementType

typedef enum {
    XML_ELEMENT_NODE=		1,
    XML_ATTRIBUTE_NODE=		2,
    XML_TEXT_NODE=		3,
    XML_CDATA_SECTION_NODE=	4,
    XML_ENTITY_REF_NODE=	5,
    XML_ENTITY_NODE=		6,
    XML_PI_NODE=		7,
    XML_COMMENT_NODE=		8,
    XML_DOCUMENT_NODE=		9,
    XML_DOCUMENT_TYPE_NODE=	10,
    XML_DOCUMENT_FRAG_NODE=	11,
    XML_NOTATION_NODE=		12
} xmlElementType;

CHAR

xmlNotationPtr

enum xmlAttributeType

typedef enum {
    XML_ATTRIBUTE_CDATA = 1,
    XML_ATTRIBUTE_ID,
    XML_ATTRIBUTE_IDREF	,
    XML_ATTRIBUTE_IDREFS,
    XML_ATTRIBUTE_ENTITY,
    XML_ATTRIBUTE_ENTITIES,
    XML_ATTRIBUTE_NMTOKEN,
    XML_ATTRIBUTE_NMTOKENS,
    XML_ATTRIBUTE_ENUMERATION,
    XML_ATTRIBUTE_NOTATION
} xmlAttributeType;

enum xmlAttributeDefault

typedef enum {
    XML_ATTRIBUTE_NONE = 1,
    XML_ATTRIBUTE_REQUIRED,
    XML_ATTRIBUTE_IMPLIED,
    XML_ATTRIBUTE_FIXED
} xmlAttributeDefault;

xmlEnumerationPtr

xmlAttributePtr

enum xmlElementContentType

typedef enum {
    XML_ELEMENT_CONTENT_PCDATA = 1,
    XML_ELEMENT_CONTENT_ELEMENT,
    XML_ELEMENT_CONTENT_SEQ,
    XML_ELEMENT_CONTENT_OR
} xmlElementContentType;

enum xmlElementContentOccur

typedef enum {
    XML_ELEMENT_CONTENT_ONCE = 1,
    XML_ELEMENT_CONTENT_OPT,
    XML_ELEMENT_CONTENT_MULT,
    XML_ELEMENT_CONTENT_PLUS
} xmlElementContentOccur;

xmlElementContentPtr

enum xmlElementTypeVal

typedef enum {
    XML_ELEMENT_TYPE_EMPTY = 1,
    XML_ELEMENT_TYPE_ANY,
    XML_ELEMENT_TYPE_MIXED,
    XML_ELEMENT_TYPE_ELEMENT
} xmlElementTypeVal;

xmlElementPtr

enum xmlNsType

typedef enum {
    XML_GLOBAL_NAMESPACE = 1,	/* old style global namespace */
    XML_LOCAL_NAMESPACE		/* new style local scoping */
} xmlNsType;

xmlNsPtr

xmlDtdPtr

xmlAttrPtr

xmlNode

xmlNodePtr

xmlDoc

xmlDocPtr

xmlBuffer

xmlBufferPtr

baseDTD

extern xmlNsPtr baseDTD;

oldXMLWDcompatibility

extern int oldXMLWDcompatibility;/* maintain compatibility with old WD */

xmlIndentTreeOutput

extern int xmlIndentTreeOutput;  /* try to indent the tree dumps */

xmlBufferCreate ()

xmlBufferPtr xmlBufferCreate                (void);

routine to create an XML buffer.

Returns :

xmlBufferFree ()

void        xmlBufferFree                   (xmlBufferPtr buf);

Frees an XML buffer.

buf :

xmlBufferDump ()

int         xmlBufferDump                   (FILE *file,
                                             xmlBufferPtr buf);

Dumps an XML buffer to a FILE *.

`file` :
`buf` :
Returns :

xmlBufferAdd ()

void        xmlBufferAdd                    (xmlBufferPtr buf,
                                             const CHAR *str,
                                             int len);

Add a string range to an XML buffer.

`buf` :
`str` :
`len` :

xmlBufferCat ()

void        xmlBufferCat                    (xmlBufferPtr buf,
                                             const CHAR *str);

Append a zero terminated string to an XML buffer.

`buf` :
`str` :

xmlBufferCCat ()

void        xmlBufferCCat                   (xmlBufferPtr buf,
                                             const char *str);

Append a zero terminated C string to an XML buffer.

`buf` :
`str` :

xmlBufferShrink ()

int         xmlBufferShrink                 (xmlBufferPtr buf,
                                             int len);

Remove the beginning of an XML buffer.

`buf` :
`len` :
Returns :

xmlBufferEmpty ()

void        xmlBufferEmpty                  (xmlBufferPtr buf);

empty a buffer.

buf :

xmlCreateIntSubset ()

xmlDtdPtr   xmlCreateIntSubset              (xmlDocPtr doc,
                                             const CHAR *name,
                                             const CHAR *ExternalID,
                                             const CHAR *SystemID);

Create the internal subset of a document

`doc` :
`name` :
`ExternalID` :
`SystemID` :
Returns :

xmlNewDtd ()

xmlDtdPtr   xmlNewDtd                       (xmlDocPtr doc,
                                             const CHAR *name,
                                             const CHAR *ExternalID,
                                             const CHAR *SystemID);

Creation of a new DTD.

`doc` :
`name` :
`ExternalID` :
`SystemID` :
Returns :

xmlFreeDtd ()

void        xmlFreeDtd                      (xmlDtdPtr cur);

Free a DTD structure.

cur :

xmlNewGlobalNs ()

xmlNsPtr    xmlNewGlobalNs                  (xmlDocPtr doc,
                                             const CHAR *href,
                                             const CHAR *prefix);

Creation of a Namespace, the old way using PI and without scoping, to AVOID.

`doc` :
`href` :
`prefix` :
Returns :

xmlNewNs ()

xmlNsPtr    xmlNewNs                        (xmlNodePtr node,
                                             const CHAR *href,
                                             const CHAR *prefix);

Creation of a new Namespace.

`node` :
`href` :
`prefix` :
Returns :

xmlFreeNs ()

void        xmlFreeNs                       (xmlNsPtr cur);

Free up the structures associated to a namespace

cur :

xmlNewDoc ()

xmlDocPtr   xmlNewDoc                       (const CHAR *version);

`version` :
Returns :

xmlFreeDoc ()

void        xmlFreeDoc                      (xmlDocPtr cur);

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

cur :

xmlNewDocProp ()

xmlAttrPtr  xmlNewDocProp                   (xmlDocPtr doc,
                                             const CHAR *name,
                                             const CHAR *value);

Create a new property carried by a document.

`doc` :
`name` :
`value` :
Returns :

xmlNewProp ()

xmlAttrPtr  xmlNewProp                      (xmlNodePtr node,
                                             const CHAR *name,
                                             const CHAR *value);

Create a new property carried by a node.

`node` :
`name` :
`value` :
Returns :

xmlFreePropList ()

void        xmlFreePropList                 (xmlAttrPtr cur);

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

cur :

xmlFreeProp ()

void        xmlFreeProp                     (xmlAttrPtr cur);

Free one property, all the childs are freed too.

cur :

xmlCopyProp ()

xmlAttrPtr  xmlCopyProp                     (xmlNodePtr target,
                                             xmlAttrPtr cur);

Do a copy of the attribute.

`target` :
`cur` :
Returns :

xmlCopyPropList ()

xmlAttrPtr  xmlCopyPropList                 (xmlNodePtr target,
                                             xmlAttrPtr cur);

Do a copy of an attribute list.

`target` :
`cur` :
Returns :

xmlCopyDtd ()

xmlDtdPtr   xmlCopyDtd                      (xmlDtdPtr dtd);

Do a copy of the dtd.

`dtd` :
Returns :

xmlCopyDoc ()

xmlDocPtr   xmlCopyDoc                      (xmlDocPtr doc,
                                             int recursive);

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

`doc` :
`recursive` :
Returns :

xmlNewDocNode ()

xmlNodePtr  xmlNewDocNode                   (xmlDocPtr doc,
                                             xmlNsPtr ns,
                                             const CHAR *name,
                                             const CHAR *content);

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

`doc` :
`ns` :
`name` :
`content` :
Returns :

xmlNewNode ()

xmlNodePtr  xmlNewNode                      (xmlNsPtr ns,
                                             const CHAR *name);

Creation of a new node element. ns and content are optionnal (NULL). If content is non NULL, a child list containing the TEXTs and ENTITY_REFs node will be created.

`ns` :
`name` :
Returns :

xmlNewChild ()

xmlNodePtr  xmlNewChild                     (xmlNodePtr parent,
                                             xmlNsPtr ns,
                                             const CHAR *name,
                                             const CHAR *content);

Creation of a new child element, added at the end of parent childs list. ns and content parameters are optionnal (NULL). If content is non NULL, a child list containing the TEXTs and ENTITY_REFs node will be created.

`parent` :
`ns` :
`name` :
`content` :
Returns :

xmlNewDocText ()

xmlNodePtr  xmlNewDocText                   (xmlDocPtr doc,
                                             const CHAR *content);

Creation of a new text node within a document.

`doc` :
`content` :
Returns :

xmlNewText ()

xmlNodePtr  xmlNewText                      (const CHAR *content);

Creation of a new text node.

`content` :
Returns :

xmlNewDocTextLen ()

xmlNodePtr  xmlNewDocTextLen                (xmlDocPtr doc,
                                             const CHAR *content,
                                             int len);

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

`doc` :
`content` :
`len` :
Returns :

xmlNewTextLen ()

xmlNodePtr  xmlNewTextLen                   (const CHAR *content,
                                             int len);

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

`content` :
`len` :
Returns :

xmlNewDocComment ()

xmlNodePtr  xmlNewDocComment                (xmlDocPtr doc,
                                             const CHAR *content);

Creation of a new node containing a commentwithin a document.

`doc` :
`content` :
Returns :

xmlNewComment ()

xmlNodePtr  xmlNewComment                   (const CHAR *content);

Creation of a new node containing a comment.

`content` :
Returns :

xmlNewCDataBlock ()

xmlNodePtr  xmlNewCDataBlock                (xmlDocPtr doc,
                                             const CHAR *content,
                                             int len);

Creation of a new node containing a CData block.

`doc` :
`content` :
`len` :
Returns :

xmlNewReference ()

xmlNodePtr  xmlNewReference                 (xmlDocPtr doc,
                                             const CHAR *name);

Creation of a new reference node.

`doc` :
`name` :
Returns :

xmlCopyNode ()

xmlNodePtr  xmlCopyNode                     (xmlNodePtr node,
                                             int recursive);

Do a copy of the node.

`node` :
`recursive` :
Returns :

xmlCopyNodeList ()

xmlNodePtr  xmlCopyNodeList                 (xmlNodePtr node);

Do a recursive copy of the node list.

`node` :
Returns :

xmlGetLastChild ()

xmlNodePtr  xmlGetLastChild                 (xmlNodePtr parent);

Search the last child of a node.

`parent` :
Returns :

xmlNodeIsText ()

int         xmlNodeIsText                   (xmlNodePtr node);

Is this node a Text node ?

`node` :
Returns :

xmlAddChild ()

xmlNodePtr  xmlAddChild                     (xmlNodePtr parent,
                                             xmlNodePtr cur);

Add a new child element, to parent, at the end of the child list.

`parent` :
`cur` :
Returns :

xmlUnlinkNode ()

void        xmlUnlinkNode                   (xmlNodePtr cur);

Unlink a node from it's current context, the node is not freed

cur :

xmlTextMerge ()

xmlNodePtr  xmlTextMerge                    (xmlNodePtr first,
                                             xmlNodePtr second);

Merge two text nodes into one

`first` :
`second` :
Returns :

xmlTextConcat ()

void        xmlTextConcat                   (xmlNodePtr node,
                                             const CHAR *content,
                                             int len);

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

`node` :
`content` :
`len` :

xmlFreeNodeList ()

void        xmlFreeNodeList                 (xmlNodePtr cur);

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

cur :

xmlFreeNode ()

void        xmlFreeNode                     (xmlNodePtr cur);

Free a node, this is a recursive behaviour, all the childs are freed too.

cur :

xmlSearchNs ()

xmlNsPtr    xmlSearchNs                     (xmlDocPtr doc,
                                             xmlNodePtr node,
                                             const CHAR *nameSpace);

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.

`doc` :
`node` :
`nameSpace` :
Returns :

xmlSearchNsByHref ()

xmlNsPtr    xmlSearchNsByHref               (xmlDocPtr doc,
                                             xmlNodePtr node,
                                             const CHAR *href);

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

`doc` :
`node` :
`href` :
Returns :

xmlSetNs ()

void        xmlSetNs                        (xmlNodePtr node,
                                             xmlNsPtr ns);

Associate a namespace to a node, a posteriori.

`node` :
`ns` :

xmlCopyNamespace ()

xmlNsPtr    xmlCopyNamespace                (xmlNsPtr cur);

Do a copy of the namespace.

`cur` :
Returns :

xmlCopyNamespaceList ()

xmlNsPtr    xmlCopyNamespaceList            (xmlNsPtr cur);

Do a copy of an namespace list.

`cur` :
Returns :

xmlSetProp ()

xmlAttrPtr  xmlSetProp                      (xmlNodePtr node,
                                             const CHAR *name,
                                             const CHAR *value);

Set (or reset) an attribute carried by a node.

`node` :
`name` :
`value` :
Returns :

xmlGetProp ()

CHAR*       xmlGetProp                      (xmlNodePtr node,
                                             const CHAR *name);

Search and get the value of an attribute associated to a node This does the entity substitution.

`node` :
`name` :
Returns :

xmlStringGetNodeList ()

xmlNodePtr  xmlStringGetNodeList            (xmlDocPtr doc,
                                             const CHAR *value);

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

`doc` :
`value` :
Returns :

xmlStringLenGetNodeList ()

xmlNodePtr  xmlStringLenGetNodeList         (xmlDocPtr doc,
                                             const CHAR *value,
                                             int len);

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

`doc` :
`value` :
`len` :
Returns :

xmlNodeListGetString ()

CHAR*       xmlNodeListGetString            (xmlDocPtr doc,
                                             xmlNodePtr list,
                                             int inLine);

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

`doc` :
`list` :
`inLine` :
Returns :

xmlNodeSetContent ()

void        xmlNodeSetContent               (xmlNodePtr cur,
                                             const CHAR *content);

Replace the content of a node.

`cur` :
`content` :

xmlNodeSetContentLen ()

void        xmlNodeSetContentLen            (xmlNodePtr cur,
                                             const CHAR *content,
                                             int len);

Replace the content of a node.

`cur` :
`content` :
`len` :

xmlNodeAddContent ()

void        xmlNodeAddContent               (xmlNodePtr cur,
                                             const CHAR *content);

Append the extra substring to the node content.

`cur` :
`content` :

xmlNodeAddContentLen ()

void        xmlNodeAddContentLen            (xmlNodePtr cur,
                                             const CHAR *content,
                                             int len);

Append the extra substring to the node content.

`cur` :
`content` :
`len` :

xmlNodeGetContent ()

CHAR*       xmlNodeGetContent               (xmlNodePtr cur);

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 substitued.

`cur` :
Returns :

xmlBufferWriteCHAR ()

void        xmlBufferWriteCHAR              (xmlBufferPtr buf,
                                             const CHAR *string);

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

`buf` :
`string` :

xmlBufferWriteChar ()

void        xmlBufferWriteChar              (xmlBufferPtr buf,
                                             const char *string);

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

`buf` :
`string` :

xmlBufferWriteQuotedString ()

void        xmlBufferWriteQuotedString      (xmlBufferPtr buf,
                                             const CHAR *string);

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

`buf` :
`string` :

xmlDocDumpMemory ()

void        xmlDocDumpMemory                (xmlDocPtr cur,
                                             CHAR **mem,
                                             int *size);

Dump an XML document in memory and return the CHAR * and it's size. It's up to the caller to free the memory.

`cur` :
`mem` :
`size` :

xmlDocDump ()

void        xmlDocDump                      (FILE *f,
                                             xmlDocPtr cur);

Dump an XML document to an open FILE.

`f` :
`cur` :

xmlSaveFile ()

int         xmlSaveFile                     (const char *filename,
                                             xmlDocPtr cur);

Dump an XML document to a file. Will use compression if compiled in and enabled.

`filename` :
`cur` :
Returns :

xmlGetDocCompressMode ()

int         xmlGetDocCompressMode           (xmlDocPtr doc);

get the compression ratio for a document, ZLIB based

`doc` :
Returns :

xmlSetDocCompressMode ()

void        xmlSetDocCompressMode           (xmlDocPtr doc,
                                             int mode);

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

`doc` :
`mode` :

xmlGetCompressMode ()

int         xmlGetCompressMode              (void);

get the default compression mode used, ZLIB based.

Returns :

xmlSetCompressMode ()

void        xmlSetCompressMode              (int mode);

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

mode :

tree

Name

Synopsis

Description

Details

enum xmlElementType

CHAR

xmlNotationPtr

enum xmlAttributeType

enum xmlAttributeDefault

xmlEnumerationPtr

xmlAttributePtr

enum xmlElementContentType

enum xmlElementContentOccur

xmlElementContentPtr

enum xmlElementTypeVal

xmlElementPtr

enum xmlNsType

xmlNsPtr

xmlDtdPtr

xmlAttrPtr

xmlNode

xmlNodePtr

xmlDoc

xmlDocPtr

xmlBuffer

xmlBufferPtr

baseDTD

oldXMLWDcompatibility

xmlIndentTreeOutput

xmlBufferCreate ()

xmlBufferFree ()

xmlBufferDump ()

xmlBufferAdd ()

xmlBufferCat ()

xmlBufferCCat ()

xmlBufferShrink ()

xmlBufferEmpty ()

xmlCreateIntSubset ()

xmlNewDtd ()

xmlFreeDtd ()

xmlNewGlobalNs ()

xmlNewNs ()

xmlFreeNs ()

xmlNewDoc ()

xmlFreeDoc ()

xmlNewDocProp ()

xmlNewProp ()

xmlFreePropList ()

xmlFreeProp ()

xmlCopyProp ()

xmlCopyPropList ()

xmlCopyDtd ()

xmlCopyDoc ()

xmlNewDocNode ()

xmlNewNode ()

xmlNewChild ()

xmlNewDocText ()

xmlNewText ()

xmlNewDocTextLen ()

xmlNewTextLen ()

xmlNewDocComment ()

xmlNewComment ()

xmlNewCDataBlock ()

xmlNewReference ()

xmlCopyNode ()

xmlCopyNodeList ()

xmlGetLastChild ()

xmlNodeIsText ()

xmlAddChild ()

xmlUnlinkNode ()

xmlTextMerge ()

xmlTextConcat ()

xmlFreeNodeList ()

xmlFreeNode ()

xmlSearchNs ()

xmlSearchNsByHref ()

xmlSetNs ()

xmlCopyNamespace ()

xmlCopyNamespaceList ()