http://swpat.ffii.org/
Action against software patents
http://www.gnome.org/
Gnome2 Logo
http://www.w3.org/Status
W3C Logo
http://www.redhat.com/
Red Hat Logo
http://xmlsoft.org/
Made with Libxml2 Logo
Module xmlreader from libxml2
API Menu
../index.html
Main Menu
../docs.html
Developer Menu
../examples/index.html
Code Examples
index.html
API Menu
libxml-parser.html
Parser API
libxml-tree.html
Tree API
libxml-xmlreader.html
Reader API
../guidelines.html
XML Guidelines
../ChangeLog.html
ChangeLog
API Indexes
../APIchunk0.html
Alphabetic
../APIconstructors.html
Constructors
../APIfunctions.html
Functions/Types
../APIfiles.html
Modules
../APIsymbols.html
Symbols
Related links
http://mail.gnome.org/archives/xml/
Mail archive
http://xmlsoft.org/XSLT/
XSLT libxslt
http://phd.cs.unibo.it/gdome2/
DOM gdome2
http://www.aleksey.com/xmlsec/
XML-DSig xmlsec
ftp://xmlsoft.org/
FTP
http://www.zlatkovic.com/projects/libxml/
Windows binaries
http://www.blastwave.org/packages.php/libxml2
Solaris binaries
http://www.explain.com.au/oss/libxml2xslt.html
MacOsX binaries
http://libxmlplusplus.sourceforge.net/
C++ bindings
http://www.zend.com/php5/articles/php5-xmlphp.php#Heading4
PHP bindings
http://sourceforge.net/projects/libxml2-pas/
Pascal bindings
http://rubyforge.org/projects/xml-tools/
Ruby bindings
http://tclxml.sourceforge.net/
Tcl bindings
http://bugzilla.gnome.org/buglist.cgi?product=libxml2
Bug Tracker
libxml-xmlmodule.html
Prev
libxml-xmlmodule.html
xmlmodule
index.html
Up
index.html
API documentation
../index.html
Home
../index.html
The XML C parser and toolkit of Gnome
libxml-xmlregexp.html
xmlregexp
libxml-xmlregexp.html
Next
API of the XML streaming API based on C# interfaces.
Table of Contents
Enum
#xmlParserProperties
xmlParserProperties
Enum
#xmlParserSeverities
xmlParserSeverities
Enum
#xmlReaderTypes
xmlReaderTypes
Structure
#xmlTextReader
xmlTextReader
struct _xmlTextReader
The content of this structure is not made public by the API.
Typedef void *
xmlTextReaderLocatorPtr
Enum
#xmlTextReaderMode
xmlTextReaderMode
Typedef
libxml-xmlreader.html#xmlTextReader
xmlTextReader
*
xmlTextReaderPtr
void
#xmlFreeTextReader
xmlFreeTextReader
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
#xmlNewTextReader
xmlNewTextReader
(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
input,
const char * URI)
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
#xmlNewTextReaderFilename
xmlNewTextReaderFilename
(const char * URI)
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
#xmlReaderForDoc
xmlReaderForDoc
(const
libxml-xmlstring.html#xmlChar
xmlChar
* cur,
const char * URL,
const char * encoding,
int options)
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
#xmlReaderForFd
xmlReaderForFd
(int fd,
const char * URL,
const char * encoding,
int options)
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
#xmlReaderForFile
xmlReaderForFile
(const char * filename,
const char * encoding,
int options)
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
#xmlReaderForIO
xmlReaderForIO
(
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
ioread,
libxml-xmlIO.html#xmlInputCloseCallback
xmlInputCloseCallback
ioclose,
void * ioctx,
const char * URL,
const char * encoding,
int options)
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
#xmlReaderForMemory
xmlReaderForMemory
(const char * buffer,
int size,
const char * URL,
const char * encoding,
int options)
int
#xmlReaderNewDoc
xmlReaderNewDoc
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* cur,
const char * URL,
const char * encoding,
int options)
int
#xmlReaderNewFd
xmlReaderNewFd
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
int fd,
const char * URL,
const char * encoding,
int options)
int
#xmlReaderNewFile
xmlReaderNewFile
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const char * filename,
const char * encoding,
int options)
int
#xmlReaderNewIO
xmlReaderNewIO
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
ioread,
libxml-xmlIO.html#xmlInputCloseCallback
xmlInputCloseCallback
ioclose,
void * ioctx,
const char * URL,
const char * encoding,
int options)
int
#xmlReaderNewMemory
xmlReaderNewMemory
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const char * buffer,
int size,
const char * URL,
const char * encoding,
int options)
int
#xmlReaderNewWalker
xmlReaderNewWalker
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc)
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
#xmlReaderWalker
xmlReaderWalker
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc)
int
#xmlTextReaderAttributeCount
xmlTextReaderAttributeCount
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderBaseUri
xmlTextReaderBaseUri
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
long
#xmlTextReaderByteConsumed
xmlTextReaderByteConsumed
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderClose
xmlTextReaderClose
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstBaseUri
xmlTextReaderConstBaseUri
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstEncoding
xmlTextReaderConstEncoding
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstLocalName
xmlTextReaderConstLocalName
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstName
xmlTextReaderConstName
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstNamespaceUri
xmlTextReaderConstNamespaceUri
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstPrefix
xmlTextReaderConstPrefix
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstString
xmlTextReaderConstString
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* str)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstValue
xmlTextReaderConstValue
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstXmlLang
xmlTextReaderConstXmlLang
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderConstXmlVersion
xmlTextReaderConstXmlVersion
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-tree.html#xmlDocPtr
xmlDocPtr
#xmlTextReaderCurrentDoc
xmlTextReaderCurrentDoc
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-tree.html#xmlNodePtr
xmlNodePtr
#xmlTextReaderCurrentNode
xmlTextReaderCurrentNode
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderDepth
xmlTextReaderDepth
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Function type:
#xmlTextReaderErrorFunc
xmlTextReaderErrorFunc
void
#xmlTextReaderErrorFunc
xmlTextReaderErrorFunc
(void * arg,
const char * msg,
libxml-xmlreader.html#xmlParserSeverities
xmlParserSeverities
severity,
libxml-xmlreader.html#xmlTextReaderLocatorPtr
xmlTextReaderLocatorPtr
locator)
libxml-tree.html#xmlNodePtr
xmlNodePtr
#xmlTextReaderExpand
xmlTextReaderExpand
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderGetAttribute
xmlTextReaderGetAttribute
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderGetAttributeNo
xmlTextReaderGetAttributeNo
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
int no)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderGetAttributeNs
xmlTextReaderGetAttributeNs
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* localName,
const
libxml-xmlstring.html#xmlChar
xmlChar
* namespaceURI)
void
#xmlTextReaderGetErrorHandler
xmlTextReaderGetErrorHandler
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlreader.html#xmlTextReaderErrorFunc
xmlTextReaderErrorFunc
* f,
void ** arg)
int
#xmlTextReaderGetParserColumnNumber
xmlTextReaderGetParserColumnNumber
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderGetParserLineNumber
xmlTextReaderGetParserLineNumber
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderGetParserProp
xmlTextReaderGetParserProp
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
int prop)
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
#xmlTextReaderGetRemainder
xmlTextReaderGetRemainder
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderHasAttributes
xmlTextReaderHasAttributes
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderHasValue
xmlTextReaderHasValue
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderIsDefault
xmlTextReaderIsDefault
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderIsEmptyElement
xmlTextReaderIsEmptyElement
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderIsNamespaceDecl
xmlTextReaderIsNamespaceDecl
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderIsValid
xmlTextReaderIsValid
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderLocalName
xmlTextReaderLocalName
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderLocatorBaseURI
xmlTextReaderLocatorBaseURI
(
libxml-xmlreader.html#xmlTextReaderLocatorPtr
xmlTextReaderLocatorPtr
locator)
int
#xmlTextReaderLocatorLineNumber
xmlTextReaderLocatorLineNumber
(
libxml-xmlreader.html#xmlTextReaderLocatorPtr
xmlTextReaderLocatorPtr
locator)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderLookupNamespace
xmlTextReaderLookupNamespace
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* prefix)
int
#xmlTextReaderMoveToAttribute
xmlTextReaderMoveToAttribute
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
int
#xmlTextReaderMoveToAttributeNo
xmlTextReaderMoveToAttributeNo
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
int no)
int
#xmlTextReaderMoveToAttributeNs
xmlTextReaderMoveToAttributeNs
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* localName,
const
libxml-xmlstring.html#xmlChar
xmlChar
* namespaceURI)
int
#xmlTextReaderMoveToElement
xmlTextReaderMoveToElement
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderMoveToFirstAttribute
xmlTextReaderMoveToFirstAttribute
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderMoveToNextAttribute
xmlTextReaderMoveToNextAttribute
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderName
xmlTextReaderName
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderNamespaceUri
xmlTextReaderNamespaceUri
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderNext
xmlTextReaderNext
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderNextSibling
xmlTextReaderNextSibling
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderNodeType
xmlTextReaderNodeType
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderNormalization
xmlTextReaderNormalization
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderPrefix
xmlTextReaderPrefix
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-tree.html#xmlNodePtr
xmlNodePtr
#xmlTextReaderPreserve
xmlTextReaderPreserve
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderPreservePattern
xmlTextReaderPreservePattern
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* pattern,
const
libxml-xmlstring.html#xmlChar
xmlChar
** namespaces)
int
#xmlTextReaderQuoteChar
xmlTextReaderQuoteChar
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderRead
xmlTextReaderRead
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderReadAttributeValue
xmlTextReaderReadAttributeValue
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderReadInnerXml
xmlTextReaderReadInnerXml
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderReadOuterXml
xmlTextReaderReadOuterXml
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderReadState
xmlTextReaderReadState
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderReadString
xmlTextReaderReadString
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
int
#xmlTextReaderRelaxNGSetSchema
xmlTextReaderRelaxNGSetSchema
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-relaxng.html#xmlRelaxNGPtr
xmlRelaxNGPtr
schema)
int
#xmlTextReaderRelaxNGValidate
xmlTextReaderRelaxNGValidate
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const char * rng)
int
#xmlTextReaderSchemaValidate
xmlTextReaderSchemaValidate
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const char * xsd)
void
#xmlTextReaderSetErrorHandler
xmlTextReaderSetErrorHandler
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlreader.html#xmlTextReaderErrorFunc
xmlTextReaderErrorFunc
f,
void * arg)
int
#xmlTextReaderSetParserProp
xmlTextReaderSetParserProp
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
int prop,
int value)
int
#xmlTextReaderSetSchema
xmlTextReaderSetSchema
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlschemas.html#xmlSchemaPtr
xmlSchemaPtr
schema)
void
#xmlTextReaderSetStructuredErrorHandler
xmlTextReaderSetStructuredErrorHandler
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlerror.html#xmlStructuredErrorFunc
xmlStructuredErrorFunc
f,
void * arg)
int
#xmlTextReaderStandalone
xmlTextReaderStandalone
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderValue
xmlTextReaderValue
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlTextReaderXmlLang
xmlTextReaderXmlLang
(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Description
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
Structure xmlTextReader
struct _xmlTextReader {
The content of this structure is not made public by the API.
}
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
}
Function: xmlFreeTextReader
void	xmlFreeTextReader		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Deallocate all the resources associated to the reader
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
Function: xmlNewTextReader
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
xmlNewTextReader	(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
input,
const char * URI)
Create an
libxml-xmlreader.html#xmlTextReader
xmlTextReader
structure fed with @input
input
:
the
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
used to read data
URI
:
the URI information for the source if available
Returns
:
the new
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
or NULL in case of error
Function: xmlNewTextReaderFilename
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
xmlNewTextReaderFilename	(const char * URI)
Create an
libxml-xmlreader.html#xmlTextReader
xmlTextReader
structure fed with the resource at @URI
URI
:
the URI of the resource to process
Returns
:
the new
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
or NULL in case of error
Function: xmlReaderForDoc
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
xmlReaderForDoc	(const
libxml-xmlstring.html#xmlChar
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.
cur
:
a pointer to a zero terminated string
URL
:
the base URL to use for the document
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
the new reader or NULL in case of error.
Function: xmlReaderForFd
libxml-xmlreader.html#xmlTextReaderPtr
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.
fd
:
an open file descriptor
URL
:
the base URL to use for the document
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
the new reader or NULL in case of error.
Function: xmlReaderForFile
libxml-xmlreader.html#xmlTextReaderPtr
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.
filename
:
a file or URL
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
the new reader or NULL in case of error.
Function: xmlReaderForIO
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
xmlReaderForIO	(
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
ioread,
libxml-xmlIO.html#xmlInputCloseCallback
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.
ioread
:
an I/O read function
ioclose
:
an I/O close function
ioctx
:
an I/O handler
URL
:
the base URL to use for the document
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
the new reader or NULL in case of error.
Function: xmlReaderForMemory
libxml-xmlreader.html#xmlTextReaderPtr
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.
buffer
:
a pointer to a char array
size
:
the size of the array
URL
:
the base URL to use for the document
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
the new reader or NULL in case of error.
Function: xmlReaderNewDoc
int	xmlReaderNewDoc			(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
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.
reader
:
an XML reader
cur
:
a pointer to a zero terminated string
URL
:
the base URL to use for the document
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
0 in case of success and -1 in case of error
Function: xmlReaderNewFd
int	xmlReaderNewFd			(
libxml-xmlreader.html#xmlTextReaderPtr
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.
reader
:
an XML reader
fd
:
an open file descriptor
URL
:
the base URL to use for the document
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
0 in case of success and -1 in case of error
Function: xmlReaderNewFile
int	xmlReaderNewFile		(
libxml-xmlreader.html#xmlTextReaderPtr
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.
reader
:
an XML reader
filename
:
a file or URL
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
0 in case of success and -1 in case of error
Function: xmlReaderNewIO
int	xmlReaderNewIO			(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
ioread,
libxml-xmlIO.html#xmlInputCloseCallback
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.
reader
:
an XML reader
ioread
:
an I/O read function
ioclose
:
an I/O close function
ioctx
:
an I/O handler
URL
:
the base URL to use for the document
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
0 in case of success and -1 in case of error
Function: xmlReaderNewMemory
int	xmlReaderNewMemory		(
libxml-xmlreader.html#xmlTextReaderPtr
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.
reader
:
an XML reader
buffer
:
a pointer to a char array
size
:
the size of the array
URL
:
the base URL to use for the document
encoding
:
the document encoding, or NULL
options
:
a combination of
libxml-parser.html#xmlParserOption
xmlParserOption
Returns
:
0 in case of success and -1 in case of error
Function: xmlReaderNewWalker
int	xmlReaderNewWalker		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc)
Setup an xmltextReader to parse a preparsed XML document. This reuses the existing @reader xmlTextReader.
reader
:
an XML reader
doc
:
a preparsed document
Returns
:
0 in case of success and -1 in case of error
Function: xmlReaderWalker
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
xmlReaderWalker	(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc)
Create an xmltextReader for a preparsed document.
doc
:
a preparsed document
Returns
:
the new reader or NULL in case of error.
Function: xmlTextReaderAttributeCount
int	xmlTextReaderAttributeCount	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Provides the number of attributes of the current node
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
0 i no attributes, -1 in case of error or the
libxml-SAX.html#attribute
attribute
count
Function: xmlTextReaderBaseUri
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderBaseUri	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The base URI of the node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the base URI or NULL if not available
Function: xmlTextReaderByteConsumed
long	xmlTextReaderByteConsumed	(
libxml-xmlreader.html#xmlTextReaderPtr
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.
reader
:
an XML reader
Returns
:
the index in bytes from the beginning of the entity or -1 in case the index could not be computed.
Function: xmlTextReaderClose
int	xmlTextReaderClose		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
This method releases any resources allocated by the current instance changes the state to Closed and close any underlying input.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
0 or -1 in case of error
Function: xmlTextReaderConstBaseUri
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstBaseUri	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The base URI of the node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the base URI or NULL if not available, the string will be deallocated with the reader
Function: xmlTextReaderConstEncoding
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstEncoding	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Determine the encoding of the document being read.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
a string containing the encoding of the document or NULL in case of error. The string is deallocated with the reader.
Function: xmlTextReaderConstLocalName
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstLocalName	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The local name of the node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the local name or NULL if not available, the string will be deallocated with the reader.
Function: xmlTextReaderConstName
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstName	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The qualified name of the node, equal to Prefix :LocalName.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the local name or NULL if not available, the string is deallocated with the reader.
Function: xmlTextReaderConstNamespaceUri
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstNamespaceUri	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The URI defining the namespace associated with the node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the namespace URI or NULL if not available, the string will be deallocated with the reader
Function: xmlTextReaderConstPrefix
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstPrefix	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
A shorthand
libxml-SAX.html#reference
reference
to the namespace associated with the node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the prefix or NULL if not available, the string is deallocated with the reader.
Function: xmlTextReaderConstString
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstString	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* str)
Get an interned string from the reader, allows for example to speedup string name comparisons
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
str
:
the string to intern.
Returns
:
an interned copy of the string or NULL in case of error. The string will be deallocated with the reader.
Function: xmlTextReaderConstValue
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstValue	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Provides the text value of the node if present
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the string or NULL if not available. The result will be deallocated on the next Read() operation.
Function: xmlTextReaderConstXmlLang
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstXmlLang	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The xml:lang scope within which the node resides.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the xml:lang value or NULL if none exists.
Function: xmlTextReaderConstXmlVersion
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderConstXmlVersion	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Determine the XML version of the document being read.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
a string containing the XML version of the document or NULL in case of error. The string is deallocated with the reader.
Function: xmlTextReaderCurrentDoc
libxml-tree.html#xmlDocPtr
xmlDocPtr
xmlTextReaderCurrentDoc	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Hacking interface allowing to get the
libxml-tree.html#xmlDocPtr
xmlDocPtr
correponding 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.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the
libxml-tree.html#xmlDocPtr
xmlDocPtr
or NULL in case of error.
Function: xmlTextReaderCurrentNode
libxml-tree.html#xmlNodePtr
xmlNodePtr
xmlTextReaderCurrentNode	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Hacking interface allowing to get the
libxml-tree.html#xmlNodePtr
xmlNodePtr
correponding to the current node being accessed by the xmlTextReader. This is dangerous because the underlying node may be destroyed on the next Reads.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the
libxml-tree.html#xmlNodePtr
xmlNodePtr
or NULL in case of error.
Function: xmlTextReaderDepth
int	xmlTextReaderDepth		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The depth of the node in the tree.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the depth or -1 in case of error
Function type: xmlTextReaderErrorFunc
Function type: xmlTextReaderErrorFunc
void	xmlTextReaderErrorFunc		(void * arg,
const char * msg,
libxml-xmlreader.html#xmlParserSeverities
xmlParserSeverities
severity,
libxml-xmlreader.html#xmlTextReaderLocatorPtr
xmlTextReaderLocatorPtr
locator)
arg
:
msg
:
severity
:
locator
:
Function: xmlTextReaderExpand
libxml-tree.html#xmlNodePtr
xmlNodePtr
xmlTextReaderExpand	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Reads the contents of the current node and the full subtree. It then makes the subtree available until the next xmlTextReaderRead() call
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
a node pointer valid until the next xmlTextReaderRead() call or NULL in case of error.
Function: xmlTextReaderGetAttribute
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderGetAttribute	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
Provides the value of the
libxml-SAX.html#attribute
attribute
with the specified qualified name.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
name
:
the qualified name of the attribute.
Returns
:
a string containing the value of the specified attribute, or NULL in case of error. The string must be deallocated by the caller.
Function: xmlTextReaderGetAttributeNo
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderGetAttributeNo	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
int no)
Provides the value of the
libxml-SAX.html#attribute
attribute
with the specified index relative to the containing element.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
no
:
the zero-based index of the
libxml-SAX.html#attribute
attribute
relative to the containing element
Returns
:
a string containing the value of the specified attribute, or NULL in case of error. The string must be deallocated by the caller.
Function: xmlTextReaderGetAttributeNs
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderGetAttributeNs	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* localName,
const
libxml-xmlstring.html#xmlChar
xmlChar
* namespaceURI)
Provides the value of the specified
libxml-SAX.html#attribute
attribute
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
localName
:
the local name of the attribute.
namespaceURI
:
the namespace URI of the attribute.
Returns
:
a string containing the value of the specified attribute, or NULL in case of error. The string must be deallocated by the caller.
Function: xmlTextReaderGetErrorHandler
void	xmlTextReaderGetErrorHandler	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlreader.html#xmlTextReaderErrorFunc
xmlTextReaderErrorFunc
* f,
void ** arg)
Retrieve the error callback function and user argument.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
f
:
the callback function or NULL is no callback has been registered
arg
:
a user argument
Function: xmlTextReaderGetParserColumnNumber
int	xmlTextReaderGetParserColumnNumber	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Provide the column number of the current parsing point.
reader
:
the user data (XML reader context)
Returns
:
an int or 0 if not available
Function: xmlTextReaderGetParserLineNumber
int	xmlTextReaderGetParserLineNumber	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Provide the line number of the current parsing point.
reader
:
the user data (XML reader context)
Returns
:
an int or 0 if not available
Function: xmlTextReaderGetParserProp
int	xmlTextReaderGetParserProp	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
int prop)
Read the parser internal property.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
prop
:
the
libxml-xmlreader.html#xmlParserProperties
xmlParserProperties
to get
Returns
:
the value, usually 0 or 1, or -1 in case of error.
Function: xmlTextReaderGetRemainder
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
xmlTextReaderGetRemainder	(
libxml-xmlreader.html#xmlTextReaderPtr
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 procgressed past what's left in reader->input, and there is an allocation problem. Best would be to rewrite it differently.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
attached to the XML or NULL in case of error.
Function: xmlTextReaderHasAttributes
int	xmlTextReaderHasAttributes	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Whether the node has attributes.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 if true, 0 if false, and -1 in case or error
Function: xmlTextReaderHasValue
int	xmlTextReaderHasValue		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Whether the node can have a text value.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 if true, 0 if false, and -1 in case or error
Function: xmlTextReaderIsDefault
int	xmlTextReaderIsDefault		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Whether an Attribute node was generated from the default value defined in the DTD or schema.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
0 if not defaulted, 1 if defaulted, and -1 in case of error
Function: xmlTextReaderIsEmptyElement
int	xmlTextReaderIsEmptyElement	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Check if the current node is empty
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 if empty, 0 if not and -1 in case of error
Function: xmlTextReaderIsNamespaceDecl
int	xmlTextReaderIsNamespaceDecl	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Determine whether the current node is a namespace declaration rather than a regular attribute.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 if the current node is a namespace declaration, 0 if it is a regular
libxml-SAX.html#attribute
attribute
or other type of node, or -1 in case of error.
Function: xmlTextReaderIsValid
int	xmlTextReaderIsValid		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Retrieve the validity status from the parser context
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the flag value 1 if valid, 0 if no, and -1 in case of error
Function: xmlTextReaderLocalName
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderLocalName	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The local name of the node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the local name or NULL if not available
Function: xmlTextReaderLocatorBaseURI
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderLocatorBaseURI	(
libxml-xmlreader.html#xmlTextReaderLocatorPtr
xmlTextReaderLocatorPtr
locator)
Obtain the base URI for the given locator.
locator
:
the
libxml-xmlreader.html#xmlTextReaderLocatorPtr
xmlTextReaderLocatorPtr
used
Returns
:
the base URI or NULL in case of error.
Function: xmlTextReaderLocatorLineNumber
int	xmlTextReaderLocatorLineNumber	(
libxml-xmlreader.html#xmlTextReaderLocatorPtr
xmlTextReaderLocatorPtr
locator)
Obtain the line number for the given locator.
locator
:
the
libxml-xmlreader.html#xmlTextReaderLocatorPtr
xmlTextReaderLocatorPtr
used
Returns
:
the line number or -1 in case of error.
Function: xmlTextReaderLookupNamespace
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderLookupNamespace	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* prefix)
Resolves a namespace prefix in the scope of the current element.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
prefix
:
the prefix whose namespace URI is to be resolved. To return the default namespace, specify NULL
Returns
:
a string containing the namespace URI to which the prefix maps or NULL in case of error. The string must be deallocated by the caller.
Function: xmlTextReaderMoveToAttribute
int	xmlTextReaderMoveToAttribute	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
Moves the position of the current instance to the
libxml-SAX.html#attribute
attribute
with the specified qualified name.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
name
:
the qualified name of the attribute.
Returns
:
1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderMoveToAttributeNo
int	xmlTextReaderMoveToAttributeNo	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
int no)
Moves the position of the current instance to the
libxml-SAX.html#attribute
attribute
with the specified index relative to the containing element.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
no
:
the zero-based index of the
libxml-SAX.html#attribute
attribute
relative to the containing element.
Returns
:
1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderMoveToAttributeNs
int	xmlTextReaderMoveToAttributeNs	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* localName,
const
libxml-xmlstring.html#xmlChar
xmlChar
* namespaceURI)
Moves the position of the current instance to the
libxml-SAX.html#attribute
attribute
with the specified local name and namespace URI.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
localName
:
the local name of the attribute.
namespaceURI
:
the namespace URI of the attribute.
Returns
:
1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderMoveToElement
int	xmlTextReaderMoveToElement	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Moves the position of the current instance to the node that contains the current Attribute node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 in case of success, -1 in case of error, 0 if not moved
Function: xmlTextReaderMoveToFirstAttribute
int	xmlTextReaderMoveToFirstAttribute	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Moves the position of the current instance to the first
libxml-SAX.html#attribute
attribute
associated with the current node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderMoveToNextAttribute
int	xmlTextReaderMoveToNextAttribute	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Moves the position of the current instance to the next
libxml-SAX.html#attribute
attribute
associated with the current node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderName
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderName	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The qualified name of the node, equal to Prefix :LocalName.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the local name or NULL if not available
Function: xmlTextReaderNamespaceUri
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderNamespaceUri	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The URI defining the namespace associated with the node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the namespace URI or NULL if not available
Function: xmlTextReaderNext
int	xmlTextReaderNext		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Skip to the node following the current one in document order while avoiding the subtree if any.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 if the node was read successfully, 0 if there is no more nodes to read, or -1 in case of error
Function: xmlTextReaderNextSibling
int	xmlTextReaderNextSibling	(
libxml-xmlreader.html#xmlTextReaderPtr
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
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 if the node was read successfully, 0 if there is no more nodes to read, or -1 in case of error
Function: xmlTextReaderNodeType
int	xmlTextReaderNodeType		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Get the node type of the current node Reference: http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the xmlNodeType of the current node or -1 in case of error
Function: xmlTextReaderNormalization
int	xmlTextReaderNormalization	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The value indicating whether to normalize white space and
libxml-SAX.html#attribute
attribute
values. Since
libxml-SAX.html#attribute
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 &#0; is of course not supported either.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 or -1 in case of error.
Function: xmlTextReaderPrefix
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderPrefix	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
A shorthand
libxml-SAX.html#reference
reference
to the namespace associated with the node.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the prefix or NULL if not available
Function: xmlTextReaderPreserve
libxml-tree.html#xmlNodePtr
xmlNodePtr
xmlTextReaderPreserve	(
libxml-xmlreader.html#xmlTextReaderPtr
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
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the
libxml-tree.html#xmlNodePtr
xmlNodePtr
or NULL in case of error.
Function: xmlTextReaderPreservePattern
int	xmlTextReaderPreservePattern	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const
libxml-xmlstring.html#xmlChar
xmlChar
* pattern,
const
libxml-xmlstring.html#xmlChar
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
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
pattern
:
an XPath subset pattern
namespaces
:
the prefix definitions, array of [URI, prefix] or NULL
Returns
:
a positive number in case of success and -1 in case of error
Function: xmlTextReaderQuoteChar
int	xmlTextReaderQuoteChar		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The quotation mark character used to enclose the value of an attribute.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
" or ' and -1 in case of error
Function: xmlTextReaderRead
int	xmlTextReaderRead		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Moves the position of the current instance to the next node in the stream, exposing its properties.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 if the node was read successfully, 0 if there is no more nodes to read, or -1 in case of error
Function: xmlTextReaderReadAttributeValue
int	xmlTextReaderReadAttributeValue	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Parses an
libxml-SAX.html#attribute
attribute
value into one or more Text and EntityReference nodes.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 in case of success, 0 if the reader was not positionned on an ttribute node or all the
libxml-SAX.html#attribute
attribute
values have been read, or -1 in case of error.
Function: xmlTextReaderReadInnerXml
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderReadInnerXml	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Reads the contents of the current node, including child nodes and markup.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
a string containing the XML content, or NULL if the current node is neither an element nor attribute, or has no child nodes. The string must be deallocated by the caller.
Function: xmlTextReaderReadOuterXml
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderReadOuterXml	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Reads the contents of the current node, including child nodes and markup.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
a string containing the XML content, or NULL if the current node is neither an element nor attribute, or has no child nodes. The string must be deallocated by the caller.
Function: xmlTextReaderReadState
int	xmlTextReaderReadState		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Gets the read state of the reader.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the state value, or -1 in case of error
Function: xmlTextReaderReadString
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderReadString	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Reads the contents of an element or a text node as a string.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
a string containing the contents of the Element or Text node, or NULL if the reader is positioned on any other type of node. The string must be deallocated by the caller.
Function: xmlTextReaderRelaxNGSetSchema
int	xmlTextReaderRelaxNGSetSchema	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-relaxng.html#xmlRelaxNGPtr
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 desactivated. @ The @schema should not be freed until the reader is deallocated or its use has been deactivated.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
schema
:
a precompiled RelaxNG schema
Returns
:
0 in case the RelaxNG validation could be (des)activated and -1 in case of error.
Function: xmlTextReaderRelaxNGValidate
int	xmlTextReaderRelaxNGValidate	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
const char * rng)
Use RelaxNG to validate the document as it is processed. Activation is only possible before the first Read(). if @rng is NULL, then RelaxNG validation is desactivated.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
rng
:
the path to a RelaxNG schema or NULL
Returns
:
0 in case the RelaxNG validation could be (des)activated and -1 in case of error.
Function: xmlTextReaderSchemaValidate
int	xmlTextReaderSchemaValidate	(
libxml-xmlreader.html#xmlTextReaderPtr
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 RelaxNG validation is desactivated.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
xsd
:
the path to a W3C XSD schema or NULL
Returns
:
0 in case the schemas validation could be (des)activated and -1 in case of error.
Function: xmlTextReaderSetErrorHandler
void	xmlTextReaderSetErrorHandler	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlreader.html#xmlTextReaderErrorFunc
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.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
f
:
the callback function to call on error and warnings
arg
:
a user argument to pass to the callback function
Function: xmlTextReaderSetParserProp
int	xmlTextReaderSetParserProp	(
libxml-xmlreader.html#xmlTextReaderPtr
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.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
prop
:
the
libxml-xmlreader.html#xmlParserProperties
xmlParserProperties
to set
value
:
usually 0 or 1 to (de)activate it
Returns
:
0 if the call was successful, or -1 in case of error
Function: xmlTextReaderSetSchema
int	xmlTextReaderSetSchema		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlschemas.html#xmlSchemaPtr
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 desactivated. @ The @schema should not be freed until the reader is deallocated or its use has been deactivated.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
schema
:
a precompiled Schema schema
Returns
:
0 in case the Schema validation could be (des)activated and -1 in case of error.
Function: xmlTextReaderSetStructuredErrorHandler
void	xmlTextReaderSetStructuredErrorHandler	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader,
libxml-xmlerror.html#xmlStructuredErrorFunc
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.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
f
:
the callback function to call on error and warnings
arg
:
a user argument to pass to the callback function
Function: xmlTextReaderStandalone
int	xmlTextReaderStandalone		(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Determine the standalone status of the document being read.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
1 if the document was declared to be standalone, 0 if it was declared to be not standalone, or -1 if the document did not specify its standalone status or in case of error.
Function: xmlTextReaderValue
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderValue	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
Provides the text value of the node if present
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the string or NULL if not available. The result must be deallocated with xmlFree()
Function: xmlTextReaderXmlLang
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlTextReaderXmlLang	(
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
reader)
The xml:lang scope within which the node resides.
reader
:
the
libxml-xmlreader.html#xmlTextReaderPtr
xmlTextReaderPtr
used
Returns
:
the xml:lang value or NULL if none exists.
../bugs.html
Daniel Veillard
