Enum xmlParserProperties

enum xmlParserProperties {
    XML_PARSER_LOADDTD = 1
    XML_PARSER_DEFAULTATTRS = 2
    XML_PARSER_VALIDATE = 3
    XML_PARSER_SUBST_ENTITIES = 4
};

Enum xmlParserSeverities

enum xmlParserSeverities {
    XML_PARSER_SEVERITY_VALIDITY_WARNING = 1
    XML_PARSER_SEVERITY_VALIDITY_ERROR = 2
    XML_PARSER_SEVERITY_WARNING = 3
    XML_PARSER_SEVERITY_ERROR = 4
};

Enum xmlReaderTypes

enum xmlReaderTypes {
    XML_READER_TYPE_NONE = 0
    XML_READER_TYPE_ELEMENT = 1
    XML_READER_TYPE_ATTRIBUTE = 2
    XML_READER_TYPE_TEXT = 3
    XML_READER_TYPE_CDATA = 4
    XML_READER_TYPE_ENTITY_REFERENCE = 5
    XML_READER_TYPE_ENTITY = 6
    XML_READER_TYPE_PROCESSING_INSTRUCTION = 7
    XML_READER_TYPE_COMMENT = 8
    XML_READER_TYPE_DOCUMENT = 9
    XML_READER_TYPE_DOCUMENT_TYPE = 10
    XML_READER_TYPE_DOCUMENT_FRAGMENT = 11
    XML_READER_TYPE_NOTATION = 12
    XML_READER_TYPE_WHITESPACE = 13
    XML_READER_TYPE_SIGNIFICANT_WHITESPACE = 14
    XML_READER_TYPE_END_ELEMENT = 15
    XML_READER_TYPE_END_ENTITY = 16
    XML_READER_TYPE_XML_DECLARATION = 17
};

Structure xmlTextReader

struct _xmlTextReader {
The content of this structure is not made public by the API.
} xmlTextReader;

Typedef xmlTextReaderLocatorPtr

void * xmlTextReaderLocatorPtr;

Enum xmlTextReaderMode

enum xmlTextReaderMode {
    XML_TEXTREADER_MODE_INITIAL = 0
    XML_TEXTREADER_MODE_INTERACTIVE = 1
    XML_TEXTREADER_MODE_ERROR = 2
    XML_TEXTREADER_MODE_EOF = 3
    XML_TEXTREADER_MODE_CLOSED = 4
    XML_TEXTREADER_MODE_READING = 5
};

Typedef xmlTextReaderPtr

xmlTextReader * xmlTextReaderPtr;

Pointer to an xmlReader context.

Function type xmlTextReaderErrorFunc

void	xmlTextReaderErrorFunc		(void * arg, 
					 const char * msg, 
					 xmlParserSeverities severity, 
					 xmlTextReaderLocatorPtr locator)

Signature of an error callback from a reader parser

xmlFreeTextReader ()

void	xmlFreeTextReader		(xmlTextReaderPtr reader)

Deallocate all the resources associated to the reader

xmlNewTextReader ()

xmlTextReaderPtr	xmlNewTextReader	(xmlParserInputBufferPtr input, 
						 const char * URI)

Create an xmlTextReader structure fed with @input

xmlNewTextReaderFilename ()

xmlTextReaderPtr	xmlNewTextReaderFilename	(const char * URI)

Create an xmlTextReader structure fed with the resource at @URI

xmlReaderForDoc ()

xmlTextReaderPtr	xmlReaderForDoc	(const xmlChar * cur, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

Create an xmltextReader for an XML in-memory document. The parsing flags @options are a combination of xmlParserOption.

xmlReaderForFd ()

xmlTextReaderPtr	xmlReaderForFd	(int fd, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

Create an xmltextReader for an XML from a file descriptor. The parsing flags @options are a combination of xmlParserOption. NOTE that the file descriptor will not be closed when the reader is closed or reset.

xmlReaderForFile ()

xmlTextReaderPtr	xmlReaderForFile	(const char * filename, 
						 const char * encoding, 
						 int options)

parse an XML file from the filesystem or the network. The parsing flags @options are a combination of xmlParserOption.

xmlReaderForIO ()

xmlTextReaderPtr	xmlReaderForIO	(xmlInputReadCallback ioread, 
					 xmlInputCloseCallback ioclose, 
					 void * ioctx, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

Create an xmltextReader for an XML document from I/O functions and source. The parsing flags @options are a combination of xmlParserOption.

xmlReaderForMemory ()

xmlTextReaderPtr	xmlReaderForMemory	(const char * buffer, 
						 int size, 
						 const char * URL, 
						 const char * encoding, 
						 int options)

Create an xmltextReader for an XML in-memory document. The parsing flags @options are a combination of xmlParserOption.

xmlReaderNewDoc ()

int	xmlReaderNewDoc			(xmlTextReaderPtr reader, 
					 const xmlChar * cur, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

Setup an xmltextReader to parse an XML in-memory document. The parsing flags @options are a combination of xmlParserOption. This reuses the existing @reader xmlTextReader.

xmlReaderNewFd ()

int	xmlReaderNewFd			(xmlTextReaderPtr reader, 
					 int fd, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

Setup an xmltextReader to parse an XML from a file descriptor. NOTE that the file descriptor will not be closed when the reader is closed or reset. The parsing flags @options are a combination of xmlParserOption. This reuses the existing @reader xmlTextReader.

xmlReaderNewFile ()

int	xmlReaderNewFile		(xmlTextReaderPtr reader, 
					 const char * filename, 
					 const char * encoding, 
					 int options)

parse an XML file from the filesystem or the network. The parsing flags @options are a combination of xmlParserOption. This reuses the existing @reader xmlTextReader.

xmlReaderNewIO ()

int	xmlReaderNewIO			(xmlTextReaderPtr reader, 
					 xmlInputReadCallback ioread, 
					 xmlInputCloseCallback ioclose, 
					 void * ioctx, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

Setup an xmltextReader to parse an XML document from I/O functions and source. The parsing flags @options are a combination of xmlParserOption. This reuses the existing @reader xmlTextReader.

xmlReaderNewMemory ()

int	xmlReaderNewMemory		(xmlTextReaderPtr reader, 
					 const char * buffer, 
					 int size, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

Setup an xmltextReader to parse an XML in-memory document. The parsing flags @options are a combination of xmlParserOption. This reuses the existing @reader xmlTextReader.

xmlReaderNewWalker ()

int	xmlReaderNewWalker		(xmlTextReaderPtr reader, 
					 xmlDocPtr doc)

Setup an xmltextReader to parse a preparsed XML document. This reuses the existing @reader xmlTextReader.

xmlReaderWalker ()

xmlTextReaderPtr	xmlReaderWalker	(xmlDocPtr doc)

Create an xmltextReader for a preparsed document.

xmlTextReaderAttributeCount ()

int	xmlTextReaderAttributeCount	(xmlTextReaderPtr reader)

Provides the number of attributes of the current node

xmlTextReaderBaseUri ()

xmlChar *	xmlTextReaderBaseUri	(xmlTextReaderPtr reader)

The base URI of the node.

xmlTextReaderByteConsumed ()

long	xmlTextReaderByteConsumed	(xmlTextReaderPtr reader)

This function provides the current index of the parser used by the reader, relative to the start of the current entity. This function actually just wraps a call to xmlBytesConsumed() for the parser context associated with the reader. See xmlBytesConsumed() for more information.

xmlTextReaderClose ()

int	xmlTextReaderClose		(xmlTextReaderPtr reader)

This method releases any resources allocated by the current instance changes the state to Closed and close any underlying input.

xmlTextReaderConstBaseUri ()

const xmlChar *	xmlTextReaderConstBaseUri	(xmlTextReaderPtr reader)

The base URI of the node.

xmlTextReaderConstEncoding ()

const xmlChar *	xmlTextReaderConstEncoding	(xmlTextReaderPtr reader)

Determine the encoding of the document being read.

xmlTextReaderConstLocalName ()

const xmlChar *	xmlTextReaderConstLocalName	(xmlTextReaderPtr reader)

The local name of the node.

xmlTextReaderConstName ()

const xmlChar *	xmlTextReaderConstName	(xmlTextReaderPtr reader)

The qualified name of the node, equal to Prefix :LocalName.

xmlTextReaderConstNamespaceUri ()

const xmlChar *	xmlTextReaderConstNamespaceUri	(xmlTextReaderPtr reader)

The URI defining the namespace associated with the node.

xmlTextReaderConstPrefix ()

const xmlChar *	xmlTextReaderConstPrefix	(xmlTextReaderPtr reader)

A shorthand reference to the namespace associated with the node.

xmlTextReaderConstString ()

const xmlChar *	xmlTextReaderConstString	(xmlTextReaderPtr reader, 
						 const xmlChar * str)

Get an interned string from the reader, allows for example to speedup string name comparisons

xmlTextReaderConstValue ()

const xmlChar *	xmlTextReaderConstValue	(xmlTextReaderPtr reader)

Provides the text value of the node if present

xmlTextReaderConstXmlLang ()

const xmlChar *	xmlTextReaderConstXmlLang	(xmlTextReaderPtr reader)

The xml:lang scope within which the node resides.

xmlTextReaderConstXmlVersion ()

const xmlChar *	xmlTextReaderConstXmlVersion	(xmlTextReaderPtr reader)

Determine the XML version of the document being read.

xmlTextReaderCurrentDoc ()

xmlDocPtr	xmlTextReaderCurrentDoc	(xmlTextReaderPtr reader)

Hacking interface allowing to get the xmlDocPtr corresponding to the current document being accessed by the xmlTextReader. NOTE: as a result of this call, the reader will not destroy the associated XML document and calling xmlFreeDoc() on the result is needed once the reader parsing has finished.

xmlTextReaderCurrentNode ()

xmlNodePtr	xmlTextReaderCurrentNode	(xmlTextReaderPtr reader)

Hacking interface allowing to get the xmlNodePtr corresponding to the current node being accessed by the xmlTextReader. This is dangerous because the underlying node may be destroyed on the next Reads.

xmlTextReaderDepth ()

int	xmlTextReaderDepth		(xmlTextReaderPtr reader)

The depth of the node in the tree.

xmlTextReaderExpand ()

xmlNodePtr	xmlTextReaderExpand	(xmlTextReaderPtr reader)

Reads the contents of the current node and the full subtree. It then makes the subtree available until the next xmlTextReaderRead() call

xmlTextReaderGetAttribute ()

xmlChar *	xmlTextReaderGetAttribute	(xmlTextReaderPtr reader, 
						 const xmlChar * name)

Provides the value of the attribute with the specified qualified name.

xmlTextReaderGetAttributeNo ()

xmlChar *	xmlTextReaderGetAttributeNo	(xmlTextReaderPtr reader, 
						 int no)

Provides the value of the attribute with the specified index relative to the containing element.

xmlTextReaderGetAttributeNs ()

xmlChar *	xmlTextReaderGetAttributeNs	(xmlTextReaderPtr reader, 
						 const xmlChar * localName, 
						 const xmlChar * namespaceURI)

Provides the value of the specified attribute

xmlTextReaderGetErrorHandler ()

void	xmlTextReaderGetErrorHandler	(xmlTextReaderPtr reader, 
					 xmlTextReaderErrorFunc * f, 
					 void ** arg)

Retrieve the error callback function and user argument.

xmlTextReaderGetParserColumnNumber ()

int	xmlTextReaderGetParserColumnNumber	(xmlTextReaderPtr reader)

Provide the column number of the current parsing point.

xmlTextReaderGetParserLineNumber ()

int	xmlTextReaderGetParserLineNumber	(xmlTextReaderPtr reader)

Provide the line number of the current parsing point.

xmlTextReaderGetParserProp ()

int	xmlTextReaderGetParserProp	(xmlTextReaderPtr reader, 
					 int prop)

Read the parser internal property.

xmlTextReaderGetRemainder ()

xmlParserInputBufferPtr	xmlTextReaderGetRemainder	(xmlTextReaderPtr reader)

Method to get the remainder of the buffered XML. this method stops the parser, set its state to End Of File and return the input stream with what is left that the parser did not use. The implementation is not good, the parser certainly progressed past what's left in reader->input, and there is an allocation problem. Best would be to rewrite it differently.

xmlTextReaderHasAttributes ()

int	xmlTextReaderHasAttributes	(xmlTextReaderPtr reader)

Whether the node has attributes.

xmlTextReaderHasValue ()

int	xmlTextReaderHasValue		(xmlTextReaderPtr reader)

Whether the node can have a text value.

xmlTextReaderIsDefault ()

int	xmlTextReaderIsDefault		(xmlTextReaderPtr reader)

Whether an Attribute node was generated from the default value defined in the DTD or schema.

xmlTextReaderIsEmptyElement ()

int	xmlTextReaderIsEmptyElement	(xmlTextReaderPtr reader)

Check if the current node is empty

xmlTextReaderIsNamespaceDecl ()

int	xmlTextReaderIsNamespaceDecl	(xmlTextReaderPtr reader)

Determine whether the current node is a namespace declaration rather than a regular attribute.

xmlTextReaderIsValid ()

int	xmlTextReaderIsValid		(xmlTextReaderPtr reader)

Retrieve the validity status from the parser context

xmlTextReaderLocalName ()

xmlChar *	xmlTextReaderLocalName	(xmlTextReaderPtr reader)

The local name of the node.

xmlTextReaderLocatorBaseURI ()

xmlChar *	xmlTextReaderLocatorBaseURI	(xmlTextReaderLocatorPtr locator)

Obtain the base URI for the given locator.

xmlTextReaderLocatorLineNumber ()

int	xmlTextReaderLocatorLineNumber	(xmlTextReaderLocatorPtr locator)

Obtain the line number for the given locator.

xmlTextReaderLookupNamespace ()

xmlChar *	xmlTextReaderLookupNamespace	(xmlTextReaderPtr reader, 
						 const xmlChar * prefix)

Resolves a namespace prefix in the scope of the current element.

xmlTextReaderMoveToAttribute ()

int	xmlTextReaderMoveToAttribute	(xmlTextReaderPtr reader, 
					 const xmlChar * name)

Moves the position of the current instance to the attribute with the specified qualified name.

xmlTextReaderMoveToAttributeNo ()

int	xmlTextReaderMoveToAttributeNo	(xmlTextReaderPtr reader, 
					 int no)

Moves the position of the current instance to the attribute with the specified index relative to the containing element.

xmlTextReaderMoveToAttributeNs ()

int	xmlTextReaderMoveToAttributeNs	(xmlTextReaderPtr reader, 
					 const xmlChar * localName, 
					 const xmlChar * namespaceURI)

Moves the position of the current instance to the attribute with the specified local name and namespace URI.

xmlTextReaderMoveToElement ()

int	xmlTextReaderMoveToElement	(xmlTextReaderPtr reader)

Moves the position of the current instance to the node that contains the current Attribute node.

xmlTextReaderMoveToFirstAttribute ()

int	xmlTextReaderMoveToFirstAttribute	(xmlTextReaderPtr reader)

Moves the position of the current instance to the first attribute associated with the current node.

xmlTextReaderMoveToNextAttribute ()

int	xmlTextReaderMoveToNextAttribute	(xmlTextReaderPtr reader)

Moves the position of the current instance to the next attribute associated with the current node.

xmlTextReaderName ()

xmlChar *	xmlTextReaderName	(xmlTextReaderPtr reader)

The qualified name of the node, equal to Prefix :LocalName.

xmlTextReaderNamespaceUri ()

xmlChar *	xmlTextReaderNamespaceUri	(xmlTextReaderPtr reader)

The URI defining the namespace associated with the node.

xmlTextReaderNext ()

int	xmlTextReaderNext		(xmlTextReaderPtr reader)

Skip to the node following the current one in document order while avoiding the subtree if any.

xmlTextReaderNextSibling ()

int	xmlTextReaderNextSibling	(xmlTextReaderPtr reader)

Skip to the node following the current one in document order while avoiding the subtree if any. Currently implemented only for Readers built on a document

xmlTextReaderNodeType ()

int	xmlTextReaderNodeType		(xmlTextReaderPtr reader)

Get the node type of the current node Reference: http://www.gnu.org/software/dotgnu/pnetlib-doc/System/Xml/XmlNodeType.php

xmlTextReaderNormalization ()

int	xmlTextReaderNormalization	(xmlTextReaderPtr reader)

The value indicating whether to normalize white space and attribute values. Since attribute value and end of line normalizations are a MUST in the XML specification only the value true is accepted. The broken bahaviour of accepting out of range character entities like � is of course not supported either.

xmlTextReaderPrefix ()

xmlChar *	xmlTextReaderPrefix	(xmlTextReaderPtr reader)

A shorthand reference to the namespace associated with the node.

xmlTextReaderPreserve ()

xmlNodePtr	xmlTextReaderPreserve	(xmlTextReaderPtr reader)

This tells the XML Reader to preserve the current node. The caller must also use xmlTextReaderCurrentDoc() to keep an handle on the resulting document once parsing has finished

xmlTextReaderPreservePattern ()

int	xmlTextReaderPreservePattern	(xmlTextReaderPtr reader, 
					 const xmlChar * pattern, 
					 const xmlChar ** namespaces)

This tells the XML Reader to preserve all nodes matched by the pattern. The caller must also use xmlTextReaderCurrentDoc() to keep an handle on the resulting document once parsing has finished

xmlTextReaderQuoteChar ()

int	xmlTextReaderQuoteChar		(xmlTextReaderPtr reader)

The quotation mark character used to enclose the value of an attribute.

xmlTextReaderRead ()

int	xmlTextReaderRead		(xmlTextReaderPtr reader)

Moves the position of the current instance to the next node in the stream, exposing its properties.

xmlTextReaderReadAttributeValue ()

int	xmlTextReaderReadAttributeValue	(xmlTextReaderPtr reader)

Parses an attribute value into one or more Text and EntityReference nodes.

xmlTextReaderReadInnerXml ()

xmlChar *	xmlTextReaderReadInnerXml	(xmlTextReaderPtr reader)

Reads the contents of the current node, including child nodes and markup.

xmlTextReaderReadOuterXml ()

xmlChar *	xmlTextReaderReadOuterXml	(xmlTextReaderPtr reader)

Reads the contents of the current node, including child nodes and markup.

xmlTextReaderReadState ()

int	xmlTextReaderReadState		(xmlTextReaderPtr reader)

Gets the read state of the reader.

xmlTextReaderReadString ()

xmlChar *	xmlTextReaderReadString	(xmlTextReaderPtr reader)

Reads the contents of an element or a text node as a string.

xmlTextReaderRelaxNGSetSchema ()

int	xmlTextReaderRelaxNGSetSchema	(xmlTextReaderPtr reader, 
					 xmlRelaxNGPtr schema)

Use RelaxNG to validate the document as it is processed. Activation is only possible before the first Read(). if @schema is NULL, then RelaxNG validation is deactivated. @ The @schema should not be freed until the reader is deallocated or its use has been deactivated.

xmlTextReaderRelaxNGValidate ()

int	xmlTextReaderRelaxNGValidate	(xmlTextReaderPtr reader, 
					 const char * rng)

Use RelaxNG schema to validate the document as it is processed. Activation is only possible before the first Read(). If @rng is NULL, then RelaxNG schema validation is deactivated.

xmlTextReaderRelaxNGValidateCtxt ()

int	xmlTextReaderRelaxNGValidateCtxt	(xmlTextReaderPtr reader, 
						 xmlRelaxNGValidCtxtPtr ctxt, 
						 int options)

Use RelaxNG schema context to validate the document as it is processed. Activation is only possible before the first Read(). If @ctxt is NULL, then RelaxNG schema validation is deactivated.

xmlTextReaderSchemaValidate ()

int	xmlTextReaderSchemaValidate	(xmlTextReaderPtr reader, 
					 const char * xsd)

Use W3C XSD schema to validate the document as it is processed. Activation is only possible before the first Read(). If @xsd is NULL, then XML Schema validation is deactivated.

xmlTextReaderSchemaValidateCtxt ()

int	xmlTextReaderSchemaValidateCtxt	(xmlTextReaderPtr reader, 
					 xmlSchemaValidCtxtPtr ctxt, 
					 int options)

Use W3C XSD schema context to validate the document as it is processed. Activation is only possible before the first Read(). If @ctxt is NULL, then XML Schema validation is deactivated.

xmlTextReaderSetErrorHandler ()

void	xmlTextReaderSetErrorHandler	(xmlTextReaderPtr reader, 
					 xmlTextReaderErrorFunc f, 
					 void * arg)

Register a callback function that will be called on error and warnings. If @f is NULL, the default error and warning handlers are restored.

xmlTextReaderSetParserProp ()

int	xmlTextReaderSetParserProp	(xmlTextReaderPtr reader, 
					 int prop, 
					 int value)

Change the parser processing behaviour by changing some of its internal properties. Note that some properties can only be changed before any read has been done.

xmlTextReaderSetSchema ()

int	xmlTextReaderSetSchema		(xmlTextReaderPtr reader, 
					 xmlSchemaPtr schema)

Use XSD Schema to validate the document as it is processed. Activation is only possible before the first Read(). if @schema is NULL, then Schema validation is deactivated. The @schema should not be freed until the reader is deallocated or its use has been deactivated.

xmlTextReaderSetStructuredErrorHandler ()

void	xmlTextReaderSetStructuredErrorHandler	(xmlTextReaderPtr reader, 
						 xmlStructuredErrorFunc f, 
						 void * arg)

Register a callback function that will be called on error and warnings. If @f is NULL, the default error and warning handlers are restored.

xmlTextReaderSetup ()

int	xmlTextReaderSetup		(xmlTextReaderPtr reader, 
					 xmlParserInputBufferPtr input, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

Setup an XML reader with new options

xmlTextReaderStandalone ()

int	xmlTextReaderStandalone		(xmlTextReaderPtr reader)

Determine the standalone status of the document being read.

xmlTextReaderValue ()

xmlChar *	xmlTextReaderValue	(xmlTextReaderPtr reader)

Provides the text value of the node if present

xmlTextReaderXmlLang ()

xmlChar *	xmlTextReaderXmlLang	(xmlTextReaderPtr reader)

The xml:lang scope within which the node resides.