From 4b8328d7b3ce3c73cc9350efa0b9df769d82321d Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Thu, 5 Jul 2001 22:48:42 +0000 Subject: rebuilt the docs for the release Daniel * doc/html/*: rebuilt the docs for the release Daniel --- doc/html/index.sgml | 1 + doc/html/libxml-catalog.html | 42 +- doc/html/libxml-debugxml.html | 103 +-- doc/html/libxml-docbparser.html | 287 +++++-- doc/html/libxml-encoding.html | 385 ++++++--- doc/html/libxml-entities.html | 186 +++-- doc/html/libxml-htmlparser.html | 434 +++++++--- doc/html/libxml-htmltree.html | 158 ++-- doc/html/libxml-nanoftp.html | 228 +++--- doc/html/libxml-nanohttp.html | 128 +-- doc/html/libxml-parser.html | 891 +++++++++++--------- doc/html/libxml-parserinternals.html | 887 ++++++++++---------- doc/html/libxml-sax.html | 346 ++++---- doc/html/libxml-tree.html | 1472 +++++++++++++++++++--------------- doc/html/libxml-uri.html | 56 +- doc/html/libxml-valid.html | 694 +++++++++------- doc/html/libxml-xinclude.html | 17 +- doc/html/libxml-xmlerror.html | 74 +- doc/html/libxml-xmlio.html | 363 +++++---- doc/html/libxml-xmlmemory.html | 163 ++-- doc/html/libxml-xpath.html | 452 +++++++---- doc/html/libxml-xpathinternals.html | 904 +++++++++++---------- doc/html/libxml-xpointer.html | 218 ++--- 23 files changed, 4862 insertions(+), 3627 deletions(-) (limited to 'doc') diff --git a/doc/html/index.sgml b/doc/html/index.sgml index 80bba16f..de2aad3d 100644 --- a/doc/html/index.sgml +++ b/doc/html/index.sgml @@ -546,6 +546,7 @@ + diff --git a/doc/html/libxml-catalog.html b/doc/html/libxml-catalog.html index 57e010c2..180e9d9f 100644 --- a/doc/html/libxml-catalog.html +++ b/doc/html/libxml-catalog.html @@ -122,7 +122,7 @@ NAME="LIBXML-CATALOG" >

Name

Synopsis

Description

Details

  the file.

  the system ID string the resource name if found or NULL otherwise.

  the public ID string the system ID if found or NULL otherwise.

Name

Synopsis

Description

Details

  a string prompt a string which will be freed by the Shell

xmlShellCtxtPtr

typedef xmlShellCtxt *xmlShellCtxtPtr;

  a shell context  a string argument  a first node  a second node an int, negative returns indicating errors

  the initial document  the output buffer  the line reading function  the output FILE*

Name

Synopsis

Description

Details

docbParserCtxt

typedef xmlParserCtxt docbParserCtxt;

docbParserCtxtPtr

typedef xmlParserCtxtPtr docbParserCtxtPtr;

docbParserNodeInfo

typedef xmlParserNodeInfo docbParserNodeInfo;

docbSAXHandler

typedef xmlSAXHandler docbSAXHandler;

docbSAXHandlerPtr

typedef xmlSAXHandlerPtr docbSAXHandlerPtr;

docbParserInput

typedef xmlParserInput docbParserInput;

docbParserInputPtr

typedef xmlParserInputPtr docbParserInputPtr;

docbDocPtr

typedef xmlDocPtr docbDocPtr;

docbNodePtr

typedef xmlNodePtr docbNodePtr;

  a pointer to an array of bytes to store the result  the length of out  a pointer to an array of UTF-8 chars  the length of in  the quote character to escape (' or ") or zero. 0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed +as the return value is positive, else unpredictiable. +The value of outlen after return is the number of octets consumed.

  a pointer to an array of xmlChar  a free form C string describing the SGML document encoding, or NULL  the SAX handler block  if using SAX, this pointer will be provided on callbacks.  the resulting document tree

  a pointer to an array of xmlChar  a free form C string describing the SGML document encoding, or NULL the resulting document tree

  the filename  a free form C string describing the SGML document encoding, or NULL  the SAX handler block  if using SAX, this pointer will be provided on callbacks.  the resulting document tree

  the filename  a free form C string describing document encoding, or NULL the resulting document tree

  an SGML parser context

  a SAX handler  The user data returned on SAX callbacks  a pointer to an array of chars  number of chars in the array  an optional file name or URI  an optional encoding the new parser context or NULL

  an XML parser context  an char array  the size in byte of the chunk  last chunk indicator zero if no error, the xmlParserErrors otherwise.

  the filename  the SGML document encoding, or NULL the new parser context or NULL

  an SGML parser context 0, -1 in case of error. the parser context is augmented +as a result of the parsing.

Name

Synopsis

Description

Details

  a pointer ot an array of bytes to store the UTF-8 result  the lenght of out  a pointer ot an array of chars in the original encoding  the lenght of in the number of byte written, or -1 by lack of space, or -2 +if the transcoding failed. +The value of inlen after return is the number of octets consumed +as the return value is positive, else unpredictiable. +The value of outlen after return is the number of ocetes consumed.

  a pointer ot an array of bytes to store the result  the lenght of out  a pointer ot an array of UTF-8 chars  the lenght of in the number of byte written, or -1 by lack of space, or -2 +if the transcoding failed. +The value of inlen after return is the number of octets consumed +as the return value is positive, else unpredictiable. +The value of outlen after return is the number of ocetes consumed.

xmlCharEncodingHandlerPtr

typedef xmlCharEncodingHandler *xmlCharEncodingHandlerPtr;

  the xmlCharEncodingHandlerPtr handler block

  a string describing the char encoding. the handler or NULL if not found

  the encoding name as parsed, in UTF-8 format (ASCII actually)  the alias name as parsed, in UTF-8 format (ASCII actually) 0 in case of success, -1 in case of error

  the alias name as parsed, in UTF-8 format (ASCII actually) 0 in case of success, -1 in case of error

  the alias name as parsed, in UTF-8 format (ASCII actually) NULL if not found the original name otherwise

  the encoding name as parsed, in UTF-8 format (ASCII actually) one of the XML_CHAR_ENCODING_... values or XML_CHAR_ENCODING_NONE +if not recognized.

  the encoding the canonical name for the given encoding

  a pointer to the first bytes of the XML entity, must be at least +4 bytes long.  pointer to the length of the buffer one of the XML_CHAR_ENCODING_... values.

  char enconding transformation data structure  an xmlBuffer for the output.  an xmlBuffer for the input the number of byte written if success, or +-1 general error +-2 if the transcoding fails (for *in is not valid utf8 string or +the result of transformation can't fit into the encoding we want), or

  char enconding transformation data structure  an xmlBuffer for the output.  an xmlBuffer for the input the number of byte written if success, or +-1 general error +-2 if the transcoding fails (for *in is not valid utf8 string or +the result of transformation can't fit into the encoding we want), or

  char enconding transformation data structure  an xmlBuffer for the output.  an xmlBuffer for the input the number of byte written if success, or +-1 general error +-2 if the transcoding fails (for *in is not valid utf8 string or +the result of transformation can't fit into the encoding we want), or

  char enconding transformation data structure 0 if success, or -1 in case of error

  a pointer to an array of bytes to store the result  the length of out  a pointer to an array of UTF-8 chars  the length of in 0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed +as the return value is positive, else unpredictiable. +The value of outlen after return is the number of ocetes consumed.

  a pointer to an array of bytes to store the result  the length of out  a pointer to an array of ISO Latin 1 chars  the length of in 0 if success, or -1 otherwise +The value of inlen after return is the number of octets consumed +as the return value is positive, else unpredictiable. +The value of outlen after return is the number of ocetes consumed.

  Pointer to putative utf-8 encoded string.  true if utf is valid.

  a sequence of UTF-8 encoded bytes  the number of characters in the array the storage size of +the first 'len' characters of ARRAY

  the input UTF8 *  the len of utf (in chars) a new UTF8 * or NULL

  the input UTF8 *  the position of the desired UTF8 char (in chars) a pointer to the UTF8 character or NULL

  the input UTF8 *  the UTF8 character to be found the relative character position of the desired char +or -1 if not found

  a sequence of UTF-8 encoded bytes a pointer to a newly created string +or NULL if any problem

  a sequence of UTF-8 encoded bytes the number of characters in the string or -1 in case of error

Name

Synopsis

Description

Details

xmlEntityPtr

typedef xmlEntity *xmlEntityPtr;

xmlEntitiesTablePtr

typedef xmlEntitiesTable *xmlEntitiesTablePtr;

  the document  the entity name  the entity type XML_xxx_yyy_ENTITY  the entity external ID if available  the entity system ID if available  the entity content a pointer to the entity or NULL in case of error

  the document  the entity name  the entity type XML_xxx_yyy_ENTITY  the entity external ID if available  the entity system ID if available  the entity content a pointer to the entity or NULL in case of error

  the entity name NULL if not, othervise the entity

  the document referencing the entity  the entity name A pointer to the entity structure or NULL if not found.

  the document referencing the entity  the entity name A pointer to the entity structure or NULL if not found.

  the document referencing the entity  the entity name A pointer to the entity structure or NULL if not found.

  the document containing the string  A string to convert to XML. A newly allocated string with the substitution done.

  the document containing the string  A string to convert to XML. A newly allocated string with the substitution done.

  the document containing the string  A string to convert to XML. A newly allocated string with the substitution done.

 the xmlEntitiesTablePtr just created or NULL in case of error.

  An entity table the new xmlEntitiesTablePtr or NULL in case of error.

  An entity table

  An XML buffer.  An entity table

  An XML buffer.  An entity table

Name

Synopsis

Description

Details

htmlParserCtxt

typedef xmlParserCtxt htmlParserCtxt;

htmlParserCtxtPtr

typedef xmlParserCtxtPtr htmlParserCtxtPtr;

htmlParserNodeInfo

typedef xmlParserNodeInfo htmlParserNodeInfo;

htmlSAXHandler

typedef xmlSAXHandler htmlSAXHandler;

htmlSAXHandlerPtr

typedef xmlSAXHandlerPtr htmlSAXHandlerPtr;

htmlParserInput

typedef xmlParserInput htmlParserInput;

htmlParserInputPtr

typedef xmlParserInputPtr htmlParserInputPtr;

htmlDocPtr

typedef xmlDocPtr htmlDocPtr;

htmlNodePtr

typedef xmlNodePtr htmlNodePtr;

htmlElemDescPtr

typedef htmlElemDesc *htmlElemDescPtr;

htmlEntityDescPtr

typedef htmlEntityDesc *htmlEntityDescPtr;

  The tag name in lowercase the related htmlElemDescPtr or NULL if not found.

  the entity name the associated htmlEntityDescPtr if found, NULL otherwise.

  the entity's unicode value the associated htmlEntityDescPtr if found, NULL otherwise.

  the HTML document  the HTML element 1 if autoclosed, 0 otherwise

  the HTML document  The tag name  the HTML element 1 if autoclose, 0 otherwise

  an HTML parser context  location to store the entity name the associated htmlEntityDescPtr if found, or NULL otherwise, +if non-NULL *str will have to be freed by the caller.

  an HTML parser context the value parsed (as an int)

  an HTML parser context

parse an HTML in-memory document and build a tree. -It use the given SAX function block to handle the parsing callback. -If sax is NULL, fallback to the default DOM tree building routines.

Parse an HTML in-memory document. If sax is not NULL, use the SAX callbacks +to handle parse events. If sax is NULL, fallback to the default DOM +behavior and return a tree.

  a pointer to an array of xmlChar  a free form C string describing the HTML document encoding, or NULL  the SAX handler block  if using SAX, this pointer will be provided on callbacks.  the resulting document tree unless SAX is NULL or the document is +not well formed.

  a pointer to an array of xmlChar  a free form C string describing the HTML document encoding, or NULL the resulting document tree

  the filename  a free form C string describing the HTML document encoding, or NULL  the SAX handler block  if using SAX, this pointer will be provided on callbacks.  the resulting document tree unless SAX is NULL or the document is +not well formed.

  the filename  a free form C string describing the HTML document encoding, or NULL the resulting document tree

  a pointer to an array of bytes to store the result  the length of out  a pointer to an array of UTF-8 chars  the length of in 0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed +as the return value is positive, else unpredictiable. +The value of outlen after return is the number of octets consumed.

  a pointer to an array of bytes to store the result  the length of out  a pointer to an array of UTF-8 chars  the length of in  the quote character to escape (' or ") or zero. 0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed +as the return value is positive, else unpredictiable. +The value of outlen after return is the number of octets consumed.

  an attribute name 1 is the attribute is a script 0 otherwise

  int 0 or 1  the last value for 0 for no handling, 1 for auto insertion.

  an HTML parser context

  a SAX handler  The user data returned on SAX callbacks  a pointer to an array of chars  number of chars in the array  an optional file name or URI  an optional encoding the new parser context or NULL

  an XML parser context  an char array  the size in byte of the chunk  last chunk indicator zero if no error, the xmlParserErrors otherwise.

Name

Synopsis

Description

Details

#define     HTML_TEXT_NODE
#define HTML_TEXT_NODE XML_TEXT_NODE

#define     HTML_ENTITY_REF_NODE
#define HTML_ENTITY_REF_NODE XML_ENTITY_REF_NODE

#define     HTML_COMMENT_NODE
#define HTML_COMMENT_NODE XML_COMMENT_NODE

#define     HTML_PRESERVE_NODE
#define HTML_PRESERVE_NODE XML_CDATA_SECTION_NODE

#define     HTML_PI_NODE
#define HTML_PI_NODE XML_PI_NODE

  URI for the dtd, or NULL  the external ID of the DTD, or NULL a new document

  URI for the dtd, or NULL  the external ID of the DTD, or NULL a new document, do not intialize the DTD if not provided

  the document the current encoding as flagged in the HTML source

  the document  the encoding string 0 in case of success and -1 in case of error

  the document  OUT: the memory pointer  OUT: the memory length

  the FILE*  the document  the number of byte written or -1 in case of failure.

  the filename (or URL)  the document  the number of byte written or -1 in case of failure.

  the HTML buffer output  the document  the current node

  the FILE pointer  the document  the current node

  the FILE pointer  the document  the current node  the document encoding  should formatting spaces been added  the number of byte written or -1 in case of failure.

  the filename  the document  the document encoding  the number of byte written or -1 in case of failure.

  the filename  the document  the document encoding  should formatting spaces been added  the number of byte written or -1 in case of failure.

Name

Synopsis

Description

Details

  user provided data for the callback  the file name (including "->" when links are shown)  the attribute string  the owner string  the group string  the file size  the link count  the year  the month  the day  the hour  the minute

  the user provided context  the data received  its size in bytes

  The URL used to initialize the context

  an FTP context

  an FTP server name  the port (use 21 if 0)

  the URL to the resource

  an FTP context -1 in case of error, 0 otherwise

  an FTP context -1 incase of error, 0 otherwise

  an FTP context -1 in case of error, 0 otherwise

  The proxy URL used to initialize the proxy context

  the proxy host name  the proxy port  the proxy user name  the proxy password  the type of proxy 1 for using SITE, 2 for USER ab

  an FTP context  The URL used to update the context 0 if Ok, -1 in case of error (other host).

  an FTP context the code number

  an FTP context the code number, or 0

  an FTP context  a directory on the server -1 incase of error, 1 if CWD worked, 0 if it failed

  an FTP context -1 incase of error, 0 otherwise

  an FTP context -1 incase of error, 0 otherwise

  an FTP context  the user callback  the user callback data  optional files to list -1 incase of error, 0 otherwise

  an FTP context  the file to retrieve (or NULL if path is in context). the socket for the data connection, or <0 in case of error

  an FTP context  the user callback  the user callback data  the file to retrieve -1 incase of error, 0 otherwise

  the FTP context  a buffer  the buffer length the number of byte read. 0 is an indication of an end of connection. +-1 indicates a parameter error.

Name

Synopsis

Description

Details

  The proxy URL used to initialize the proxy context

  The URL to load  the filename where the content should be saved  if available the Content-Type information will be +returned at that location -1 in case of failure, 0 incase of success. The contentType, +if provided must be freed by the caller

  The URL to load  the HTTP method to use  the input string if any  the Content-Type information IN and OUT  the extra headers

  The URL to load  the HTTP method to use  the input string if any  the Content-Type information IN and OUT  the redirected URL OUT  the extra headers

  The URL to load  if available the Content-Type information will be +returned at that location

  The URL to load  if available the Content-Type information will be +returned at that location  if availble the redirected URL will be returned

  the HTTP context the HTTP return code for the request.

  the HTTP context the stashed value of the WWW-Authenticate or Proxy-Authenticate +header.

  the HTTP context  a buffer  the buffer length the number of byte read. 0 is an indication of an end of connection. +-1 indicates a parameter error.

  the HTTP context  the filename where the content should be saved -1 in case of failure, 0 incase of success.

  the HTTP contextxmlChar *str, - xmlChar *val); @@ -1270,7 +1270,7 @@ CELLPADDING="6" >
#define     XML_DEFAULT_VERSION
#define XML_DEFAULT_VERSION "1.0"xmlParserInputPtr

typedef xmlParserInput *xmlParserInputPtr;

xmlParserNodeInfoPtr

typedef xmlParserNodeInfo *xmlParserNodeInfoPtr;

xmlParserNodeInfoSeqPtr

typedef xmlParserNodeInfoSeq *xmlParserNodeInfoSeqPtr;

#define     XML_DETECT_IDS
#define XML_DETECT_IDS 2

#define     XML_COMPLETE_ATTRS
#define XML_COMPLETE_ATTRS 4

xmlParserCtxtPtr

typedef xmlParserCtxt *xmlParserCtxtPtr;

xmlSAXLocatorPtr

typedef xmlSAXLocator *xmlSAXLocatorPtr;

xmlSAXHandlerPtr

typedef xmlSAXHandler *xmlSAXHandlerPtr;

  The System ID of the resource requested  The Public ID of the resource requested

#define     xmlSubstituteEntitiesDefaultValue
#define xmlSubstituteEntitiesDefaultValue xmlSubstituteEntitiesDefaultVal

  an XML parser input  an indicative size for the lookahead the number of xmlChars read, or -1 in case of error, 0 indicate the +end of this entity

  an XML parser input  an indicative size for the lookahead the number of xmlChars read, or -1 in case of error, 0 indicate the +end of this entity

  the input xmlChar * a new xmlChar * or NULL

  the input xmlChar *  the len of cur a new xmlChar * or NULL

  the input char *  the len of cur a new xmlChar * or NULL

  the input char * a new xmlChar * or NULL

  the xmlChar * array (haystack)  the index of the first char (zero based)  the length of the substring the xmlChar * for the first occurence or NULL.

  the xmlChar * array  the xmlChar to search the xmlChar * for the first occurence or NULL.

xmlChar *str, - xmlChar *val);

  the xmlChar * array (haystack)  the xmlChar to search (needle) the xmlChar * for the first occurence or NULL.

  the xmlChar * array (haystack)  the xmlChar to search (needle) the xmlChar * for the first occurence or NULL.

  the first xmlChar *  the second xmlChar * the integer result of the comparison

  the first xmlChar *  the second xmlChar *  the max comparison length the integer result of the comparison

  the first xmlChar *  the second xmlChar * the integer result of the comparison

  the first xmlChar *  the second xmlChar *  the max comparison length the integer result of the comparison

  the first xmlChar *  the second xmlChar * 1 if they are equal, 0 if they are different

  the xmlChar * array the number of xmlChar contained in the ARRAY.

  the original xmlChar * array  the xmlChar * array added a new xmlChar * containing the concatenated string.

  the original xmlChar * array  the xmlChar * array added  the length of add a new xmlChar *, the original cur is reallocated if needed +and should not be freed

  a pointer to an array of xmlChar the resulting document tree

  an pointer to a char array  the size of the array the resulting document tree

  the filename the resulting document tree

  int 0 or 1  the last value for 0 for no substitution, 1 for substitution.

  int 0 or 1  the last value for 0 for no substitution, 1 for substitution.

  an XML parser context

  int 0 or 1  the last value for 0 for no substitution, 1 for substitution.

  a pointer to an array of xmlChar the resulting document tree

  an pointer to a char array  the size of the array the resulting document tree

  the filename the resulting document tree

  an XML parser context 0, -1 in case of error. the parser context is augmented +as a result of the parsing.

  an XML parser context 0, -1 in case of error. the parser context is augmented +as a result of the parsing.

  the SAX handler block  a pointer to an array of xmlChar  work in recovery mode, i.e. tries to read no Well Formed +documents the resulting document tree

  a SAX handler  The user data returned on SAX callbacks  a file name 0 in case of success or a error number otherwise

  a SAX handler  The user data returned on SAX callbacks  an in-memory XML document input  the length of the XML document in bytes 0 in case of success or a error number otherwise

  the SAX handler block  an pointer to a char array  the size of the array  work in recovery mode, i.e. tries to read not Well Formed +documents the resulting document tree

  the SAX handler block  the filename  work in recovery mode, i.e. tries to read no Well Formed +documents the resulting document tree

  the SAX handler block  the filename the resulting document tree

  the filename the resulting document tree

  a NAME* containing the External ID of the DTD  a NAME* containing the URL to the DTD the resulting xmlDtdPtr or NULL in case of error.

  the SAX handler block  a NAME* containing the External ID of the DTD  a NAME* containing the URL to the DTD the resulting xmlDtdPtr or NULL in case of error.

  the SAX handler block or NULL  an Input Buffer  the charset encoding if known the resulting xmlDtdPtr or NULL in case of error. +input will be freed at parsing end.

  the document the chunk pertains to  the SAX handler bloc (possibly NULL)  The user data returned on SAX callbacks (possibly NULL)  Used for loop detection, use 0  the input string in UTF8 or ISO-Latin (zero terminated)  the return value for the set of parsed nodes 0 if the chunk is well balanced, -1 in case of args problem and +the parser error code otherwise

  the document the chunk pertains to  the SAX handler bloc (possibly NULL)  The user data returned on SAX callbacks (possibly NULL)  Used for loop detection, use 0  the URL for the entity to load  the System ID for the entity to load  the return value for the set of parsed nodes 0 if the entity is well formed, -1 in case of args problem and +the parser error code otherwise

  the existing parsing context  the URL for the entity to load  the System ID for the entity to load  the return value for the set of parsed nodes 0 if the entity is well formed, -1 in case of args problem and +the parser error code otherwise

  an XML parser context

  an XML parser context

  an XML parser context

  an XML parser context  a xmlChar * buffer  a file name

  a pointer to an array of xmlChar the new parser context or NULL

  a SAX handler  The user data returned on SAX callbacks  a pointer to an array of chars  number of chars in the array  an optional file name or URI the new parser context or NULL

  an XML parser context  an char array  the size in byte of the chunk  last chunk indicator zero if no error, the xmlParserErrors otherwise.

  a SAX handler  The user data returned on SAX callbacks  an I/O read function  an I/O close function  an I/O handler  the charset encoding if known the new parser context or NULL

  an XML parser context  an I/O Input  the charset encoding if known the new input stream or NULL

  an XML parser context  an XML node within the tree an xmlParserNodeInfo block pointer or NULL

  a node info sequence pointer

  a node info sequence pointer

  a node info sequence pointer  an XML node pointer a long indicating the position of the record

  an XML parser context  a node info sequence pointer

Name

Synopsis

Description

Details

#define     XML_MAX_NAMELEN
#define XML_MAX_NAMELEN 100

#define     INPUT_CHUNK
#define INPUT_CHUNK 250

  an UNICODE value (int)

  an UNICODE value (int)

#define     IS_BASECHAR(c)
#define IS_BASECHAR(c) xmlIsBaseChar(c)

  an UNICODE value (int)

#define     IS_DIGIT(c)
#define IS_DIGIT(c) xmlIsDigit(c)

  an UNICODE value (int)

#define     IS_COMBINING(c)
#define IS_COMBINING(c) xmlIsCombining(c)

  an UNICODE value (int)

#define     IS_EXTENDER(c)
#define IS_EXTENDER(c) xmlIsExtender(c)

  an UNICODE value (int)

#define     IS_IDEOGRAPHIC(c)
#define IS_IDEOGRAPHIC(c) xmlIsIdeographic(c)

  an UNICODE value (int)

#define     IS_LETTER(c)
#define IS_LETTER(c) (IS_BASECHAR(c) || IS_IDEOGRAPHIC(c))

  an UNICODE value (int)

#define     IS_PUBIDCHAR(c)
#define IS_PUBIDCHAR(c) xmlIsPubidChar(c)

  an UNICODE value (int)

  and UTF8 string pointer

  and UTF8 string pointer

  and UTF8 string pointer

  an unicode character (int) 0 if not, non-zero otherwise

  an unicode character (int) 0 if not, non-zero otherwise

  an unicode character (int) 0 if not, non-zero otherwise

  an unicode character (int) 0 if not, non-zero otherwise

  an unicode character (int) 0 if not, non-zero otherwise

  an unicode character (int) 0 if not, non-zero otherwise

  an unicode character (int) 0 if not, non-zero otherwise

  an unicode character (int) 0 if not, non-zero otherwise

  an unicode character (int) 0 if not, non-zero otherwise

  the filename the new parser context or NULL

  a pointer to a char array  the size of the array the new parser context or NULL

 the xmlParserCtxtPtr or NULL

  the entity URL  the entity PUBLIC ID  a posible base for the target URI the new parser context or NULL

  the parser context  the encoding value (number) 0 in case of success, -1 otherwise

  the parser context  the encoding handler 0 in case of success, -1 otherwise

  an XML parser context  an XML entity pointer.

  an XML parser context  an memory buffer the new input stream

  an XML parser context  an Entity pointer the new input stream or NULL

  an XML parser context  an XML parser input fragment (entity, XML fragment ...).

  an XML parser context the current xmlChar in the parser context

  an xmlParserInputPtr

  an XML parser context  the filename to use as entity the new input stream or NULL in case of error

  an XML parser context the new input stream or NULL

  an XML parser context  an XML parser context  a xmlChar **  the local part, and prefix is updated +to get the Prefix if any.

  an XML parser context the namespace name or NULL

  an XML parser context  a xmlChar **  the local part, and prefix is updated +to get the Prefix if any.

  an XML parser context the namespace name

  an XML parser context the string parser or NULL.

  an XML parser context

  an XML parser context the Name parsed or NULL

  an XML parser context the Name parsed or NULL

  an XML parser context the Nmtoken parsed or NULL

  an XML parser context  if non-NULL store a copy of the original entity value the EntityValue parsed with reference substitued or NULL

  an XML parser context the AttValue parsed or NULL. The value has to be freed by the caller.

  an XML parser context the SystemLiteral parsed or NULL

  an XML parser context the PubidLiteral parsed or NULL.

  an XML parser context  int indicating whether we are within a CDATA section

  an XML parser context  a xmlChar** receiving PubidLiteral  indicate whether we should restrict parsing to only +production [75], see NOTE below the function returns SystemLiteral and in the second +case publicID receives PubidLiteral, is strict is off +it is possible to return NULL and have publicID set.

  an XML parser context

  an XML parser context the PITarget name or NULL

  an XML parser context

  an XML parser context

  an XML parser context

  an XML parser context  Receive a possible fixed default value for the attribute  XML_ATTRIBUTE_NONE, XML_ATTRIBUTE_REQUIRED, XML_ATTRIBUTE_IMPLIED +or XML_ATTRIBUTE_FIXED.

  an XML parser context  the notation attribute tree built while parsing

  an XML parser context  the enumeration attribute tree built while parsing

  an XML parser context  the enumeration tree built while parsing  XML_ATTRIBUTE_ENUMERATION or XML_ATTRIBUTE_NOTATION

  an XML parser context  the enumeration tree built while parsing the attribute type

  an XML parser context

  an XML parser context  the list of the xmlElementContentPtr describing the element choices

  an XML parser context  the tree of xmlElementContentPtr describing the element +hierarchy.

  an XML parser context  the name of the element being defined.  the Element Content pointer will be stored here if any  the type of element content XML_ELEMENT_TYPE_xxx

  an XML parser context the type of the element, or -1 in case of error

  an XML parser context

  an XML parser context the value parsed (as an int), 0 in case of error

  an XML parser context the xmlEntityPtr if found, or NULL otherwise.

  an XML parser context

  an XML parser context

  an XML parser context

  an XML parser context  a xmlChar ** used to store the value of the attribute the attribute name, and the value in *value.

  an XML parser context the element name parsed

  an XML parser context

  an XML parser context

  an XML parser context

  an XML parser context

  an XML parser context the string giving the XML version number, or NULL

  an XML parser context the version string, e.g. "1.0"

  an XML parser context the encoding name value or NULL

  an XML parser context the encoding value or NULL

  an XML parser context 1 if standalone, 0 otherwise

  an XML parser context

  an XML parser context

  an XML parser context

  an XML parser context  the external identifier  the system identifier (or URL)

#define     XML_SUBSTITUTE_NONE
#define XML_SUBSTITUTE_NONE 0

#define     XML_SUBSTITUTE_REF
#define XML_SUBSTITUTE_REF 1

#define     XML_SUBSTITUTE_PEREF
#define XML_SUBSTITUTE_PEREF 2

#define     XML_SUBSTITUTE_BOTH
#define XML_SUBSTITUTE_BOTH 3

  the parser context  the len to decode (in bytes !), -1 for no size limit  combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF  an end marker xmlChar, 0 if none  an end marker xmlChar, 0 if none  an end marker xmlChar, 0 if none A newly allocated string with the substitution done. The caller +must deallocate it !

  the parser context  the input string  combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF  an end marker xmlChar, 0 if none  an end marker xmlChar, 0 if none  an end marker xmlChar, 0 if none A newly allocated string with the substitution done. The caller +must deallocate it !

  the XML parser context the number of space chars skipped

  the XML parser context  pointer to the beginning of the char  pointer to the length of the char read the current char value and its lenght

  the parser context

  the parser context

  the XML parser context  pointer to the length of the char read the current char value and its lenght

  pointer to an arry of xmlChar  the char value the number of xmlChar written

  Ignored, compatibility  pointer to an arry of xmlChar  the char value the number of xmlChar written

  the XML parser context

  an XML parser input

  the filename  a free form C string describing the HTML document encoding, or NULL the new parser context or NULL

Name

Synopsis

Description

Details

  the user data (XML parser context) a xmlChar *

  the user data (XML parser context) a xmlChar *

  the user data (XML parser context)  A SAX Locator

  the user data (XML parser context) an int

  the user data (XML parser context) an int

  the user data (XML parser context) 1 if true

  the user data (XML parser context) 1 if true

  the user data (XML parser context) 1 if true

  the user data (XML parser context)  the root element name  the external ID  the SYSTEM ID (e.g. filename or URL)

  the user data (XML parser context)  the root element name  the external ID  the SYSTEM ID (e.g. filename or URL)

  the user data (XML parser context)  The entity name the xmlEntityPtr if found.

  the user data (XML parser context)  The entity name the xmlEntityPtr if found.

  the user data (XML parser context)  The public ID of the entity  The system ID of the entity the xmlParserInputPtr if inlined or NULL for DOM behaviour.

  the user data (XML parser context)  the entity name   the entity type   The public ID of the entity  The system ID of the entity  the entity value (without processing).

  the user data (XML parser context)  the name of the element  the attribute type   the type of default value  the attribute default value  the tree of enumerated value set

  the user data (XML parser context)  the element name   the element type   the element value tree

  the user data (XML parser context)  The name of the notation  The public ID of the entity  The system ID of the entity

  the user data (XML parser context)  The name of the entity  The public ID of the entity  The system ID of the entity  the name of the notation

  the user data (XML parser context)

  the user data (XML parser context)

  the user data (XML parser context)  The attribute name, including namespace prefix  The attribute value

  the user data (XML parser context)  The element name, including namespace prefix  An array of name/value attributes pairs, NULL terminated

  the user data (XML parser context)  The element name

  the user data (XML parser context)  The entity name

  the user data (XML parser context)  a xmlChar string  the number of xmlChar

  the user data (XML parser context)  a xmlChar string  the number of xmlChar

  the user data (XML parser context)  the target name  the PI data's

  the user data (XML parser context)  the namespace associated URN  the namespace prefix

  the user data (XML parser context)  the namespace prefix

  the user data (XML parser context) the xmlNsPtr or NULL if none

  the user data (XML parser context)  the namespace to check against 1 if true 0 otherwise

  the user data (XML parser context)  the namespace associated URN  the namespace prefix

  the user data (XML parser context)  the comment content

  the user data (XML parser context)  The pcdata content  the block length

Name

Synopsis

Description

Details

xmlChar

typedef unsigned char xmlChar;

This is a basic byte in an UTF-8 encoded string. It's unsigned allowing to pinpoint case where char * are assigned @@ -1921,7 +1934,7 @@ to xmlChar * (possibly making serialization back impossible).

#define     BAD_CAST
#define BAD_CAST (xmlChar *)

xmlNotationPtr

typedef xmlNotation *xmlNotationPtr;

xmlEnumerationPtr

typedef xmlEnumeration *xmlEnumerationPtr;

xmlAttributePtr

typedef xmlAttribute *xmlAttributePtr;

xmlElementContentPtr

typedef xmlElementContent *xmlElementContentPtr;

xmlElementPtr

typedef xmlElement *xmlElementPtr;

#define     XML_LOCAL_NAMESPACE
#define XML_LOCAL_NAMESPACE XML_NAMESPACE_DECL

xmlNsType

typedef xmlElementType xmlNsType;

xmlNsPtr

typedef xmlNs *xmlNsPtr;

xmlDtdPtr

typedef xmlDtd *xmlDtdPtr;

xmlAttrPtr

typedef xmlAttr *xmlAttrPtr;

xmlIDPtr

typedef xmlID *xmlIDPtr;

xmlRefPtr

typedef xmlRef *xmlRefPtr;

xmlBufferPtr

typedef xmlBuffer *xmlBufferPtr;

xmlNodePtr

typedef xmlNode *xmlNodePtr;

xmlDocPtr

typedef xmlDoc *xmlDocPtr;

#define     xmlChildrenNode
#define xmlChildrenNode children

#define     xmlRootNode
#define xmlRootNode children

  allocation method to use

 the current allocation scheme

 the new structure.

  initial size of buffer the new structure.

  the buffer to resize  the desired size 0 in case of problems, 1 otherwise

  the buffer to free

  the file output  the buffer to dump the number of xmlChar written

  the buffer to dump  the xmlChar string  the number of xmlChar to add

  the buffer  the xmlChar string  the number of xmlChar to add

  the buffer to dump  the xmlChar string

  the buffer to dump  the C char string

  the buffer to dump  the number of xmlChar to remove the number of xmlChar removed, or -1 in case of failure.

  the buffer  the minimum free size to allocate the new available space or -1 in case of error

  the buffer

  the buffer the internal content

  the buffer to free  allocation scheme to use

  the buffer  the length of data in the internal content

  the document pointer  the DTD name  the external (PUBLIC) ID  the system ID a pointer to the new DTD structure

  the document pointer  the DTD name  the external ID  the system ID a pointer to the new DTD structure

  the document pointer a pointer to the DTD structure or NULL if not found

  the DTD structure to free up

  the document carrying the namespace  the URI associated  the prefix for the namespace NULL this functionnality had been removed

  the element carrying the namespace  the URI associated  the prefix for the namespace returns a new namespace pointer or NULL

  the namespace pointer

  the first namespace pointer

  xmlChar string giving the version of XML "1.0" a new document

  pointer to the document +@:

  the document  the name of the attribute  the value of the attribute a pointer to the attribute

  the holding node  the name of the attribute  the value of the attribute a pointer to the attribute

  the holding node  the namespace  the name of the attribute  the value of the attribute a pointer to the attribute

  the first property in the list

  an attribute

  the element where the attribute will be grafted  the attribute  a new xmlAttrPtr, or NULL in case of error.

  the element where the attributes will be grafted  the first attribute  a new xmlAttrPtr, or NULL in case of error.

  the dtd  a new xmlDtdPtr, or NULL in case of error.

  the document  if 1 do a recursive copy.  a new xmlDocPtr, or NULL in case of error.

  the document  namespace if any  the node name  the XML text content if any a pointer to the new node object.

  the document  namespace if any  the node name  the text content if any a pointer to the new node object.

  namespace if any  the node name a pointer to the new node object.

  the parent node  a namespace if any  the name of the child  the XML content of the child if any. a pointer to the new node object.

  the parent node  a namespace if any  the name of the child  the text content of the child if any. a pointer to the new node object.

  the document  the text content a pointer to the new node object.

  the text content a pointer to the new node object.

  the processing instruction name  the PI content a pointer to the new node object.

  the document  the text content  the text len. a pointer to the new node object.

  the text content  the text len. a pointer to the new node object.

  the document  the comment content a pointer to the new node object.

  the comment content a pointer to the new node object.

  the document  the CData block content content  the length of the block a pointer to the new node object.

  the document  the char ref string, starting with # or "&# ... ;" a pointer to the new node object.

  the document  the reference name, or the reference string with & and ; a pointer to the new node object.

  the node  if 1 do a recursive copy.  a new xmlNodePtr, or NULL in case of error.

  the node  if 1 do a recursive copy.  a new xmlNodePtr, or NULL in case of error.

  the first node in the list.  a new xmlNodePtr, or NULL in case of error.

  the document owning the fragment a pointer to the new node object.

  the document the xmlNodePtr for the root or NULL

  the parent node the last child or NULL if none.

  the node 1 yes, 0 no

  the node 1 yes, 0 no

  the document  the new document root element the old root element if any was found

  the node being changed  the new tag name

  the parent node  the child node the child or NULL in case of error.

  the parent node  the first node in the list the last child or NULL in case of error.

  the old node  the node the old node

  the child node  the new node the new element or NULL in case of error.

  the child node  the new node the new element or NULL in case of error.

  the child node  the new node the new element or NULL in case of error.

  the node

  the first text node  the second text node being merged the first text node augmented

  the node  the content  content lenght

  the first node in the list

  the node

  the top element  the document

  the document

  the document  the current node  the namespace prefix the namespace pointer or NULL.

  the document  the current node  the namespace value the namespace pointer or NULL.

  the document  the current node an NULL terminated array of all the xmlNsPtr found +that need to be freed by the caller or NULL if no +namespace if defined

  a node in the document  a namespace pointer

  the namespace  a new xmlNsPtr, or NULL in case of error.

  the first namespace  a new xmlNsPtr, or NULL in case of error.

  the node  the attribute name  the attribute value the attribute pointer.

  the node  the attribute name the attribute value or NULL if not found. +It's up to the caller to free the memory.

  the node  the attribute name the attribute or the attribute declaration or NULL if +neither was found.

  the node  the attribute name  the URI of the namespace the attribute or the attribute declaration or NULL +if neither was found.

  the node  the namespace definition  the attribute name  the attribute value the attribute pointer.

  the node  the attribute name  the URI of the namespace the attribute value or NULL if not found. +It's up to the caller to free the memory.

  the document  the value of the attribute a pointer to the first child

  the document  the value of the text  the length of the string value a pointer to the first child

  the document  a Node list  should we replace entity contents or show their external form a pointer to the string copy, the calller must free it.

  the document  a Node list  should we replace entity contents or show their external form a pointer to the string copy, the calller must free it.

  the node being modified  the new value of the content

  the node being modified  the new value of the content  the size of content

  the node being modified  extra content

  the node being modified  extra content  the size of content

  the node being read a new xmlChar * or NULL if no content is available. +It's up to the caller to free the memory.

  the node being checked a pointer to the lang value, or NULL if not found +It's up to the caller to free the memory.

  the node being changed  the langage description

  the node being checked -1 if xml:space is not inheried, 0 if "default", 1 if "preserve"

  the node being changed

  the document the node pertains to  the node being checked a pointer to the base URL, or NULL if not found +It's up to the caller to free the memory.

  the node being changed  the new base URI

 0 if success and -1 in case of error.

  the node  the attribute name 0 if successful, -1 if not found

  the node  the namespace definition  the attribute name 0 if successful, -1 if not found

  the XML buffer  the string to add

  the XML buffer output  the string to add

  the XML buffer output  the string to add

  the document  a node defining the subtree to reconciliate the number of namespace declarations created or -1 in case of error.

  the document  OUT: the memory pointer  OUT: the memory lenght  should formatting spaces been added

  the document  OUT: the memory pointer  OUT: the memory lenght

  Document to generate XML text from  Memory pointer for allocated XML text  Length of the generated XML text  Character encoding to use when generating XML text

  the FILE*  the document  the number of byte written or -1 in case of failure.

  the FILE * for the output  the document  the current node

  the filename (or URL)  the document  the number of byte written or -1 in case of failure.

  the filename (or URL)  the document  should formatting spaces been added  the number of byte written or -1 in case of failure.

  the XML buffer output  the document  the current node  the imbrication level for indenting  is formatting allowed

  the filename (or URL)  the document  the name of an encoding (or NULL)  the number of byte written or -1 in case of failure.

  the document 0 (uncompressed) to 9 (max compression)

  the document  the compression ratio

 0 (uncompressed) to 9 (max compression)

  the compression ratio

Name

Synopsis

Description

Details

Name

Synopsis

Description

Details

xmlValidStatePtr

typedef xmlValidState *xmlValidStatePtr;

xmlValidCtxtPtr

typedef xmlValidCtxt *xmlValidCtxtPtr;

xmlNotationTablePtr

typedef xmlNotationTable *xmlNotationTablePtr;

xmlElementTablePtr

typedef xmlElementTable *xmlElementTablePtr;

xmlAttributeTablePtr

typedef xmlAttributeTable *xmlAttributeTablePtr;

xmlIDTablePtr

typedef xmlIDTable *xmlIDTablePtr;

xmlRefTablePtr

typedef xmlRefTable *xmlRefTablePtr;

  an XML parser context  a xmlChar **  NULL if not a QName, otherwise the local part, and prefix +is updated to get the Prefix if any.

  the validation context  pointer to the DTD  the entity name  the public identifier or NULL  the system identifier or NULL NULL if not, othervise the entity

  A notation table the new xmlNotationTablePtr or NULL in case of error.

  An notation table

  the XML buffer output  A notation declaration

  the XML buffer output  A notation table

  the subelement name or NULL  the type of element content decl NULL if not, othervise the new element content structure

  An element content pointer. the new xmlElementContentPtr or NULL in case of error.

  the element content tree to free

  an output buffer  An element table  1 if one must print the englobing parenthesis, 0 otherwise

  the validation context  pointer to the DTD  the entity name  the element type  the element content tree or NULL NULL if not, othervise the entity

  An element table the new xmlElementTablePtr or NULL in case of error.

  An element table

  the XML buffer output  An element table

  the XML buffer output  An element table

  the enumeration name or NULL the xmlEnumerationPtr just created or NULL in case +of error.

  the tree to free.

  the tree to copy. the xmlEnumerationPtr just created or NULL in case +of error.

  the validation context  pointer to the DTD  the element name  the attribute name  the attribute namespace prefix  the attribute type  the attribute default type  the attribute default value  if it's an enumeration, the associated list NULL if not new, othervise the attribute decl

  An attribute table the new xmlAttributeTablePtr or NULL in case of error.

  An attribute table

  the XML buffer output  An attribute table

  the XML buffer output  An attribute declaration

  the validation context  pointer to the document  the value name  the attribute holding the ID NULL if not, othervise the new xmlIDPtr

  An id table

  pointer to the document  the ID value NULL if not found, otherwise the xmlAttrPtr defining the ID

  the document  the element carrying the attribute  the attribute 0 or 1 depending on the lookup result

  the document  the attribute -1 if the lookup failed and 0 otherwise

  the validation context  pointer to the document  the value name  the attribute holding the Ref NULL if not, othervise the new xmlRefPtr

  An ref table

  the document  the element carrying the attribute  the attribute 0 or 1 depending on the lookup result

  the document  the attribute -1 if the lookup failed and 0 otherwise

  pointer to the document  the ID value NULL if not found, otherwise node set for the ID.

  the validation context  a document instance 1 if valid or 0 otherwise

  the validation context  a document instance  an element definition 1 if valid or 0 otherwise

  the document  the parent  the attribute name  the attribute value a new normalized string if normalization is needed, NULL otherwise +the caller must free the returned value.

  the validation context  a document instance  an attribute definition 1 if valid or 0 otherwise

  an attribute type  an attribute value 1 if valid or 0 otherwise

  the validation context  a document instance  a notation definition 1 if valid or 0 otherwise

  the validation context  a document instance  a dtd instance 1 if valid or 0 otherwise

  the validation context  a document instance 1 if valid or 0 otherwise

  the validation context  a document instance 1 if valid or 0 otherwise

  the validation context  a document instance  an element instance 1 if valid or 0 otherwise

  the validation context  a document instance  an element instance 1 if valid or 0 otherwise

  the validation context  a document instance  an element instance  an attribute instance  the attribute value (without entities processing) 1 if valid or 0 otherwise

  the validation context  a document instance 1 if valid or 0 otherwise

  the validation context  the document  the notation name to check 1 if valid or 0 otherwise

  the document  the element name 0 if no, 1 if yes, and -1 if no element description is available

  a pointer to the DtD to search  the element name  the attribute name the xmlAttributePtr if found or NULL

  a pointer to the DtD to search  the notation name the xmlNotationPtr if found or NULL

  a pointer to the DtD to search  the element name the xmlElementPtr if found or NULL

  an element to insert after  an element to insert next  an array to store the list of child names  the size of the array the number of element in the list, or -1 in case of error. If +the function returns the value max the caller is invited to grow the +receiving array and retry.

  an element content tree  an array to store the list of child names  a pointer to the number of element in the list  the size of the array the number of element in the list, or -1 in case of error.

Name

Synopsis

Description

Details

  an XML document 0 if no substition were done, -1 if some processing failed +or the number of substitutions done.

Name

Synopsis

Description

Details

  the new error handling context  the new handler function

  an XML parser context  the message to display/transmit  extra parameters for the message display

  an XML parser context  the message to display/transmit  extra parameters for the message display

  an XML parser context  the message to display/transmit  extra parameters for the message display

  an XML parser context  the message to display/transmit  extra parameters for the message display

  an xmlParserInputPtr input

  an xmlParserInputPtr input

Name

Synopsis

Description

Details

xmlParserInputBufferPtr

typedef xmlParserInputBuffer *xmlParserInputBufferPtr;

xmlOutputBufferPtr

typedef xmlOutputBuffer *xmlOutputBufferPtr;

  the charset encoding if known the new parser input or NULL

  a C string containing the URI or filename  the charset encoding if known the new parser input or NULL

  a FILE*   the charset encoding if known the new parser input or NULL

  a file descriptor number  the charset encoding if known the new parser input or NULL

  the memory input  the length of the memory block  the charset encoding if known the new parser input or NULL

  an I/O read function  an I/O close function  an I/O handler  the charset encoding if known the new parser input or NULL

  a buffered parser input  indicative value of the amount of chars to read the number of chars read and stored in the buffer, or -1 +in case of error.

  a buffered parser input  indicative value of the amount of chars to read the number of chars read and stored in the buffer, or -1 +in case of error.

  a buffered parser input  the size in bytes of the array.  an char array the number of chars read and stored in the buffer, or -1 +in case of error.

  a buffered parser input

  the xmlInputMatchCallback  the xmlInputOpenCallback  the xmlInputReadCallback  the xmlInputCloseCallback the registered handler number or -1 in case of error

  the encoding converter or NULL the new parser output or NULL

  a C string containing the URI or filename  the encoding converter or NULL  the compression ration (0 none, 9 max). the new output or NULL

  a FILE*   the encoding converter or NULL the new parser output or NULL

  a file descriptor number  the encoding converter or NULL the new parser output or NULL

  an I/O write function  an I/O close function  an I/O handler the new parser output or NULL

  a buffered parser output  the size in bytes of the array.  an char array the number of chars immediately written, or -1 +in case of error.

  a buffered parser output  a zero terminated C string the number of chars immediately written, or -1 +in case of error.

  a buffered output the number of byte written or -1 in case of error.

  a buffered output the number of byte written or -1 in case of error.

  the xmlOutputMatchCallback  the xmlOutputOpenCallback  the xmlOutputWriteCallback  the xmlOutputCloseCallback the registered handler number or -1 in case of error

  an output I/O buffer  the document  the encoding if any assuming the i/O layer handles the trancoding  the number of byte written or -1 in case of failure.

  an output I/O buffer  the document  the encoding if any assuming the i/O layer handles the trancoding  should formatting spaces been added  the number of byte written or -1 in case of failure.

  the XML buffer output  the document  the current node  the imbrication level for indenting  is formatting allowed  an optional encoding string

  the HTML buffer output  the document  the encoding string

Name

Synopsis

Description

Details

#define     DEBUG_MEMORY
#define DEBUG_MEMORY

#define     MEM_LIST
#define MEM_LIST /* keep a list of all the allocated memory blocks */

  the free() function to use  the malloc() function to use  the realloc() function to use  the strdup() function to use 0 on success

  the free() function in use  the malloc() function in use  the realloc() function in use  the strdup() function in use 0 on success

 0 on success

 an int representing the amount of memory allocated.

  a FILE descriptor used as the output file, if NULL, the result is +written to the file .memorylist

  a FILE descriptor used as the output file  number of entries to dump

#define     xmlMalloc(x)
#define xmlMalloc(x) xmlMallocLoc((x), __FILE__, __LINE__)

#define     xmlRealloc(p, x)
#define xmlRealloc(p, x) xmlReallocLoc((p), (x), __FILE__, __LINE__)

#define     xmlMemStrdup(x)
#define xmlMemStrdup(x) xmlMemStrdupLoc((x), __FILE__, __LINE__)

  an int specifying the size in byte to allocate.  the file name or NULL  the line number

  the initial memory block pointer  an int specifying the size in byte to allocate.  the file name or NULL  the line number

  the file name or NULL  the line number a pointer to the new string or NULL if allocation error occured.

Name

Synopsis

Description

Details

xmlXPathContextPtr

typedef xmlXPathContext *xmlXPathContextPtr;

xmlXPathParserContextPtr

typedef xmlXPathParserContext *xmlXPathParserContextPtr;

xmlNodeSetPtr

typedef xmlNodeSet *xmlNodeSetPtr;

xmlXPathTypePtr

typedef xmlXPathType *xmlXPathTypePtr;

xmlXPathVariablePtr

typedef xmlXPathVariable *xmlXPathVariablePtr;

xmlXPathFuncPtr

typedef xmlXPathFunct *xmlXPathFuncPtr;

xmlXPathAxisPtr

typedef xmlXPathAxis *xmlXPathAxisPtr;

xmlXPathCompExprPtr

typedef xmlXPathCompExpr *xmlXPathCompExprPtr;

#define     xmlXPathNodeSetGetLength(ns)
#define xmlXPathNodeSetGetLength(ns) ((ns) ? (ns)->nodeNr : 0)

  the object to free

  an initial xmlNodePtr, or NULL the newly created object.

  an existing NodeSetList object

  the xmlNodeSetPtr to free

  the original object the newly created object.

  the first node  the second node -2 in case of error 1 if first point < second point, 0 if +that's the same node, -1 otherwise

  a number the boolean value

  a string the boolean value

  a node-set the boolean value

  a boolean the number value

  a string the number value

  a node the number value

  a node-set the number value

  an XPath object the number value

  a boolean a newly allocated string.

  a number a newly allocated string.

  a node a newly allocated string.

  a node-set a newly allocated string.

  an XPath object the string value of the object, NULL in case of error. +A new string is allocated only if needed (val isn't a +string object).

  an XPath object the new object, the old one is freed (or the operation +is done directly on val)

  an XPath object the new object, the old one is freed (or the operation +is done directly on val)

  an XPath object the new object, the old one is freed (or the operation +is done directly on val)

  the XML document the xmlXPathContext just allocated.

  the context to free

  the XPath expression the xmlXPathObjectPtr resulting from the eveluation or NULL. +the caller has to free the object.

  the XPath expression  the XPath context the xmlXPathObjectPtr resulting from the evaluation or NULL. +the caller has to free the object.

  the XPath context  the Predicate Expression evaluation result

  the XPath expression the xmlXPathObjectPtr resulting from the eveluation or NULL. +the caller has to free the object.

  the compiled XPath expression  the XPath context the xmlXPathObjectPtr resulting from the eveluation or NULL. +the caller has to free the object.

  an XPATH comp

Name

Synopsis

CHECK_TYPE (typeval) #define CHECK_TYPE0 (typeval) +#define CHECK_ARITY (x) @@ -1189,7 +1193,7 @@ HREF="libxml-xpath.html#XMLXPATHPARSERCONTEXTPTR" >

Description

Details

  the error code

  the error code

  the XPath type

CHECK_TYPE0()

#define     CHECK_TYPE0(typeval)

Macro to check that the value on top of the XPath stack is of a given +type. return(0) in case of failure

typeval : the XPath type

  the number of expected args

  the XPath context  the lookup function

  the FILE * to dump the output  the object to inspect  indentation level

  the XPath context  the namespace prefix  the namespace name 0 in case of success, -1 in case of error

  the XPath context the value or NULL if not found

  the XPath context  the function name  the function implementation or NULL 0 in case of success, -1 in case of error

  the XPath context  the function name  the function namespace URI  the function implementation or NULL 0 in case of success, -1 in case of error

  the XPath context  the variable name  the variable value or NULL 0 in case of success, -1 in case of error

  the XPath context  the variable name  the variable namespace URI  the variable value or NULL 0 in case of success, -1 in case of error

  the XPath context  the function name the xmlXPathFunction or NULL if not found

  the XPath context  the function name  the function namespace URI the xmlXPathFunction or NULL if not found

  the XPath context

  the XPath context  the variable name a copy of the value or NULL if not found

  the XPath context  the variable name  the variable namespace URI the a copy of the value or NULL if not found

  the XPath context

  the XPath expression  the XPath context the xmlXPathParserContext just allocated.

  the context to free

  the xmlChar * value the newly created object.

  the char * value the newly created object.

  the xmlChar * value the newly created object.

  the char * value the newly created object.

  the double value the newly created object.

  the boolean value the newly created object.

  the NodePtr value the newly created object.

  the NodePtr value the newly created object.

  the initial node set  a new xmlNodePtr

  the initial node set  a new xmlNodePtr

  the node set

  the XPath Parser context  the number of arguments

  the XPath Parser context

  the XPath Parser context

  the XPath Parser context the namespace name or NULL

  the XPath Parser context the namespace name or NULL

  A string to scan the double value.

  the XPath Parser context  the Predicate Expression evaluation result

  the XPath Parser context  the number of arguments

  the XPath context

  the first NodeSet or NULL  the second NodeSet val1 once extended or NULL in case of error.

  the initial node set  an xmlNodePtr

  the initial node set  the index to remove

  an existing NodeSet the newly created object.

  the NodePtr value the newly created object.

  the XPath Parser context 0 or 1 depending on the results of the test.

  the XPath Parser context  less than (1) or greater than (0)  is the comparison strict 1 if the comparaison succeeded, 0 if it failed

  the XPath Parser context

  the XPath Parser context

  the XPath Parser context

  the XPath Parser context

  the XPath Parser context

  the XPath Parser context

  a name string 1 if true 0 otherwise

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current attribute in the traversal the next element following that axis

  the XPath Parser context  the current attribute in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the current node in the traversal the next element following that axis

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

  the XPath Parser context  the number of arguments

Name

Synopsis

Description

Details

xmlLocationSetPtr

typedef xmlLocationSet *xmlLocationSetPtr;

  an initial xmlXPathObjectPtr, or NULL the newly created object.

  the xmlLocationSetPtr to free

  the first LocationSet  the second LocationSet val1 once extended or NULL in case of error.

  the starting node  the start index  the ending point  the ending index the newly created object.

  the starting point  the ending point the newly created object.

  the starting node  the ending point the newly created object.

  the starting point  the ending node the newly created object.

  the starting node  the ending node the newly created object.

  the start NodePtr value  the end NodePtr value or NULL the newly created object.

  a node set the newly created object.

  the starting node  the ending object the newly created object.

  the starting and ending node the newly created object.

  the initial range set  a new xmlXPathObjectPtr

  the LocationSet value the newly created object.

  the initial range set  an xmlXPathObjectPtr

  the initial range set  the index to remove

  the XML document  the node that directly contains the XPointer being evaluated or NULL  the element from which a user or program initiated traversal of +the link, or NULL. the xmlXPathContext just allocated.

  the XPointer expression  the XPointer context the xmlXPathObjectPtr resulting from the eveluation or NULL. +the caller has to free the object.

  the XPointer Parser context  the number of args

  the XPointer result from the evaluation. an xmlNodePtr list or NULL. +the caller has to free the node tree.

  the XPointer Parser context