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 xmlIO 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-xlink.html
Prev
libxml-xlink.html
xlink
index.html
Up
index.html
API documentation
../index.html
Home
../index.html
The XML C parser and toolkit of Gnome
libxml-xmlautomata.html
xmlautomata
libxml-xmlautomata.html
Next
interface for the I/O interfaces used by the parser
Table of Contents
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
#xmlAllocOutputBuffer
xmlAllocOutputBuffer
(
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder)
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
#xmlAllocParserInputBuffer
xmlAllocParserInputBuffer
(
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
int
#xmlCheckFilename
xmlCheckFilename
(const char * path)
libxml-tree.html#xmlParserInputPtr
xmlParserInputPtr
#xmlCheckHTTPInput
xmlCheckHTTPInput
(
libxml-tree.html#xmlParserCtxtPtr
xmlParserCtxtPtr
ctxt,
libxml-tree.html#xmlParserInputPtr
xmlParserInputPtr
ret)
void
#xmlCleanupInputCallbacks
xmlCleanupInputCallbacks
(void)
void
#xmlCleanupOutputCallbacks
xmlCleanupOutputCallbacks
(void)
int
#xmlFileClose
xmlFileClose
(void * context)
int
#xmlFileMatch
xmlFileMatch
(const char * filename)
void *
#xmlFileOpen
xmlFileOpen
(const char * filename)
int
#xmlFileRead
xmlFileRead
(void * context,
char * buffer,
int len)
void
#xmlFreeParserInputBuffer
xmlFreeParserInputBuffer
(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
in)
int
#xmlIOFTPClose
xmlIOFTPClose
(void * context)
int
#xmlIOFTPMatch
xmlIOFTPMatch
(const char * filename)
void *
#xmlIOFTPOpen
xmlIOFTPOpen
(const char * filename)
int
#xmlIOFTPRead
xmlIOFTPRead
(void * context,
char * buffer,
int len)
int
#xmlIOHTTPClose
xmlIOHTTPClose
(void * context)
int
#xmlIOHTTPMatch
xmlIOHTTPMatch
(const char * filename)
void *
#xmlIOHTTPOpen
xmlIOHTTPOpen
(const char * filename)
void *
#xmlIOHTTPOpenW
xmlIOHTTPOpenW
(const char * post_uri,
int compression)
int
#xmlIOHTTPRead
xmlIOHTTPRead
(void * context,
char * buffer,
int len)
Function type:
#xmlInputCloseCallback
xmlInputCloseCallback
int
#xmlInputCloseCallback
xmlInputCloseCallback
(void * context)
Function type:
#xmlInputMatchCallback
xmlInputMatchCallback
int
#xmlInputMatchCallback
xmlInputMatchCallback
(char const * filename)
Function type:
#xmlInputOpenCallback
xmlInputOpenCallback
void *
#xmlInputOpenCallback
xmlInputOpenCallback
(char const * filename)
Function type:
#xmlInputReadCallback
xmlInputReadCallback
int
#xmlInputReadCallback
xmlInputReadCallback
(void * context,
char * buffer,
int len)
libxml-tree.html#xmlParserInputPtr
xmlParserInputPtr
#xmlNoNetExternalEntityLoader
xmlNoNetExternalEntityLoader
(const char * URL,
const char * ID,
libxml-tree.html#xmlParserCtxtPtr
xmlParserCtxtPtr
ctxt)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlNormalizeWindowsPath
xmlNormalizeWindowsPath
(const
libxml-xmlstring.html#xmlChar
xmlChar
* path)
int
#xmlOutputBufferClose
xmlOutputBufferClose
(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out)
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
#xmlOutputBufferCreateFd
xmlOutputBufferCreateFd
(int fd,
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder)
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
#xmlOutputBufferCreateFile
xmlOutputBufferCreateFile
(FILE * file,
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder)
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
#xmlOutputBufferCreateFilename
xmlOutputBufferCreateFilename
(const char * URI,
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder,
int compression)
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
#xmlOutputBufferCreateIO
xmlOutputBufferCreateIO
(
libxml-xmlIO.html#xmlOutputWriteCallback
xmlOutputWriteCallback
iowrite,
libxml-xmlIO.html#xmlOutputCloseCallback
xmlOutputCloseCallback
ioclose,
void * ioctx,
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder)
int
#xmlOutputBufferFlush
xmlOutputBufferFlush
(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out)
int
#xmlOutputBufferWrite
xmlOutputBufferWrite
(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out,
int len,
const char * buf)
int
#xmlOutputBufferWriteEscape
xmlOutputBufferWriteEscape
(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out,
const
libxml-xmlstring.html#xmlChar
xmlChar
* str,
libxml-encoding.html#xmlCharEncodingOutputFunc
xmlCharEncodingOutputFunc
escaping)
int
#xmlOutputBufferWriteString
xmlOutputBufferWriteString
(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out,
const char * str)
Function type:
#xmlOutputCloseCallback
xmlOutputCloseCallback
int
#xmlOutputCloseCallback
xmlOutputCloseCallback
(void * context)
Function type:
#xmlOutputMatchCallback
xmlOutputMatchCallback
int
#xmlOutputMatchCallback
xmlOutputMatchCallback
(char const * filename)
Function type:
#xmlOutputOpenCallback
xmlOutputOpenCallback
void *
#xmlOutputOpenCallback
xmlOutputOpenCallback
(char const * filename)
Function type:
#xmlOutputWriteCallback
xmlOutputWriteCallback
int
#xmlOutputWriteCallback
xmlOutputWriteCallback
(void * context,
const char * buffer,
int len)
char *
#xmlParserGetDirectory
xmlParserGetDirectory
(const char * filename)
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
#xmlParserInputBufferCreateFd
xmlParserInputBufferCreateFd
(int fd,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
#xmlParserInputBufferCreateFile
xmlParserInputBufferCreateFile
(FILE * file,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
#xmlParserInputBufferCreateFilename
xmlParserInputBufferCreateFilename
(const char * URI,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
#xmlParserInputBufferCreateIO
xmlParserInputBufferCreateIO
(
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
ioread,
libxml-xmlIO.html#xmlInputCloseCallback
xmlInputCloseCallback
ioclose,
void * ioctx,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
#xmlParserInputBufferCreateMem
xmlParserInputBufferCreateMem
(const char * mem,
int size,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
#xmlParserInputBufferCreateStatic
xmlParserInputBufferCreateStatic
(const char * mem,
int size,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
int
#xmlParserInputBufferGrow
xmlParserInputBufferGrow
(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
in,
int len)
int
#xmlParserInputBufferPush
xmlParserInputBufferPush
(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
in,
int len,
const char * buf)
int
#xmlParserInputBufferRead
xmlParserInputBufferRead
(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
in,
int len)
int
#xmlPopInputCallbacks
xmlPopInputCallbacks
(void)
void
#xmlRegisterDefaultInputCallbacks
xmlRegisterDefaultInputCallbacks
(void)
void
#xmlRegisterDefaultOutputCallbacks
xmlRegisterDefaultOutputCallbacks
(void)
void
#xmlRegisterHTTPPostCallbacks
xmlRegisterHTTPPostCallbacks
(void)
int
#xmlRegisterInputCallbacks
xmlRegisterInputCallbacks
(
libxml-xmlIO.html#xmlInputMatchCallback
xmlInputMatchCallback
matchFunc,
libxml-xmlIO.html#xmlInputOpenCallback
xmlInputOpenCallback
openFunc,
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
readFunc,
libxml-xmlIO.html#xmlInputCloseCallback
xmlInputCloseCallback
closeFunc)
int
#xmlRegisterOutputCallbacks
xmlRegisterOutputCallbacks
(
libxml-xmlIO.html#xmlOutputMatchCallback
xmlOutputMatchCallback
matchFunc,
libxml-xmlIO.html#xmlOutputOpenCallback
xmlOutputOpenCallback
openFunc,
libxml-xmlIO.html#xmlOutputWriteCallback
xmlOutputWriteCallback
writeFunc,
libxml-xmlIO.html#xmlOutputCloseCallback
xmlOutputCloseCallback
closeFunc)
Description
Function: xmlAllocOutputBuffer
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
xmlAllocOutputBuffer	(
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder)
Create a buffered parser output
encoder
:
the encoding converter or NULL
Returns
:
the new parser output or NULL
Function: xmlAllocParserInputBuffer
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
xmlAllocParserInputBuffer	(
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
Create a buffered parser input for progressive parsing
enc
:
the charset encoding if known
Returns
:
the new parser input or NULL
Function: xmlCheckFilename
int	xmlCheckFilename		(const char * path)
function checks to see if @path is a valid source (file, socket...) for XML. if stat is not available on the target machine,
path
:
the path to check
Returns
:
1. if stat fails, returns 0 (if calling stat on the filename fails, it can't be right). if stat succeeds and the file is a directory, returns 2. otherwise returns 1.
Function: xmlCheckHTTPInput
libxml-tree.html#xmlParserInputPtr
xmlParserInputPtr
xmlCheckHTTPInput	(
libxml-tree.html#xmlParserCtxtPtr
xmlParserCtxtPtr
ctxt,
libxml-tree.html#xmlParserInputPtr
xmlParserInputPtr
ret)
Check an input in case it was created from an HTTP stream, in that case it will handle encoding and update of the base URL in case of redirection. It also checks for HTTP errors in which case the input is cleanly freed up and an appropriate error is raised in context
ctxt
:
an XML parser context
ret
:
an XML parser input
Returns
:
the input or NULL in case of HTTP error.
Function: xmlCleanupInputCallbacks
void	xmlCleanupInputCallbacks	(void)
clears the entire input callback table. this includes the compiled-in I/O.
Function: xmlCleanupOutputCallbacks
void	xmlCleanupOutputCallbacks	(void)
clears the entire output callback table. this includes the compiled-in I/O callbacks.
Function: xmlFileClose
int	xmlFileClose			(void * context)
Close an I/O channel
context
:
the I/O context
Returns
:
0 or -1 in case of error
Function: xmlFileMatch
int	xmlFileMatch			(const char * filename)
input from FILE *
filename
:
the URI for matching
Returns
:
1 if matches, 0 otherwise
Function: xmlFileOpen
void *	xmlFileOpen			(const char * filename)
Wrapper around xmlFileOpen_real that try it with an unescaped version of @filename, if this fails fallback to @filename
filename
:
the URI for matching
Returns
:
a handler or NULL in case or failure
Function: xmlFileRead
int	xmlFileRead			(void * context,
char * buffer,
int len)
Read @len bytes to @buffer from the I/O channel.
context
:
the I/O context
buffer
:
where to drop data
len
:
number of bytes to write
Returns
:
the number of bytes written or < 0 in case of failure
Function: xmlFreeParserInputBuffer
void	xmlFreeParserInputBuffer	(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
in)
Free up the memory used by a buffered parser input
in
:
a buffered parser input
Function: xmlIOFTPClose
int	xmlIOFTPClose			(void * context)
Close an FTP I/O channel
context
:
the I/O context
Returns
:
0
Function: xmlIOFTPMatch
int	xmlIOFTPMatch			(const char * filename)
check if the URI matches an FTP one
filename
:
the URI for matching
Returns
:
1 if matches, 0 otherwise
Function: xmlIOFTPOpen
void *	xmlIOFTPOpen			(const char * filename)
open an FTP I/O channel
filename
:
the URI for matching
Returns
:
an I/O context or NULL in case of error
Function: xmlIOFTPRead
int	xmlIOFTPRead			(void * context,
char * buffer,
int len)
Read @len bytes to @buffer from the I/O channel.
context
:
the I/O context
buffer
:
where to drop data
len
:
number of bytes to write
Returns
:
the number of bytes written
Function: xmlIOHTTPClose
int	xmlIOHTTPClose			(void * context)
Close an HTTP I/O channel
context
:
the I/O context
Returns
:
0
Function: xmlIOHTTPMatch
int	xmlIOHTTPMatch			(const char * filename)
check if the URI matches an HTTP one
filename
:
the URI for matching
Returns
:
1 if matches, 0 otherwise
Function: xmlIOHTTPOpen
void *	xmlIOHTTPOpen			(const char * filename)
open an HTTP I/O channel
filename
:
the URI for matching
Returns
:
an I/O context or NULL in case of error
Function: xmlIOHTTPOpenW
void *	xmlIOHTTPOpenW			(const char * post_uri,
int compression)
Open a temporary buffer to collect the document for a subsequent HTTP POST request. Non-static as is called from the output buffer creation routine.
post_uri
:
The destination URI for the document
compression
:
The compression desired for the document.
Returns
:
an I/O context or NULL in case of error.
Function: xmlIOHTTPRead
int	xmlIOHTTPRead			(void * context,
char * buffer,
int len)
Read @len bytes to @buffer from the I/O channel.
context
:
the I/O context
buffer
:
where to drop data
len
:
number of bytes to write
Returns
:
the number of bytes written
Function type: xmlInputCloseCallback
Function type: xmlInputCloseCallback
int	xmlInputCloseCallback		(void * context)
Callback used in the I/O Input API to close the resource
context
:
an Input context
Returns
:
0 or -1 in case of error
Function type: xmlInputMatchCallback
Function type: xmlInputMatchCallback
int	xmlInputMatchCallback		(char const * filename)
Callback used in the I/O Input API to detect if the current handler can provide input fonctionnalities for this resource.
filename
:
the filename or URI
Returns
:
1 if yes and 0 if another Input module should be used
Function type: xmlInputOpenCallback
Function type: xmlInputOpenCallback
void *	xmlInputOpenCallback		(char const * filename)
Callback used in the I/O Input API to open the resource
filename
:
the filename or URI
Returns
:
an Input context or NULL in case or error
Function type: xmlInputReadCallback
Function type: xmlInputReadCallback
int	xmlInputReadCallback		(void * context,
char * buffer,
int len)
Callback used in the I/O Input API to read the resource
context
:
an Input context
buffer
:
the buffer to store data read
len
:
the length of the buffer in bytes
Returns
:
the number of bytes read or -1 in case of error
Function: xmlNoNetExternalEntityLoader
libxml-tree.html#xmlParserInputPtr
xmlParserInputPtr
xmlNoNetExternalEntityLoader	(const char * URL,
const char * ID,
libxml-tree.html#xmlParserCtxtPtr
xmlParserCtxtPtr
ctxt)
A specific entity loader disabling network accesses, though still allowing local catalog accesses for resolution.
URL
:
the URL for the entity to load
ID
:
the System ID for the entity to load
ctxt
:
the context in which the entity is called or NULL
Returns
:
a new allocated xmlParserInputPtr, or NULL.
Function: xmlNormalizeWindowsPath
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlNormalizeWindowsPath	(const
libxml-xmlstring.html#xmlChar
xmlChar
* path)
This function is obsolete. Please see xmlURIFromPath in uri.c for a better solution.
path
:
the input file path
Returns
:
a canonicalized version of the path
Function: xmlOutputBufferClose
int	xmlOutputBufferClose		(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out)
flushes and close the output I/O channel and free up all the associated resources
out
:
a buffered output
Returns
:
the number of byte written or -1 in case of error.
Function: xmlOutputBufferCreateFd
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
xmlOutputBufferCreateFd	(int fd,
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder)
Create a buffered output for the progressive saving to a file descriptor
fd
:
a file descriptor number
encoder
:
the encoding converter or NULL
Returns
:
the new parser output or NULL
Function: xmlOutputBufferCreateFile
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
xmlOutputBufferCreateFile	(FILE * file,
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder)
Create a buffered output for the progressive saving to a FILE * buffered C I/O
file
:
a FILE*
encoder
:
the encoding converter or NULL
Returns
:
the new parser output or NULL
Function: xmlOutputBufferCreateFilename
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
xmlOutputBufferCreateFilename	(const char * URI,
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder,
int compression)
Create a buffered output for the progressive saving of a file If filename is "-' then we use stdout as the output. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. TODO: currently if compression is set, the library only support writing to a local file.
URI
:
a C string containing the URI or filename
encoder
:
the encoding converter or NULL
compression
:
the compression ration (0 none, 9 max).
Returns
:
the new output or NULL
Function: xmlOutputBufferCreateIO
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
xmlOutputBufferCreateIO	(
libxml-xmlIO.html#xmlOutputWriteCallback
xmlOutputWriteCallback
iowrite,
libxml-xmlIO.html#xmlOutputCloseCallback
xmlOutputCloseCallback
ioclose,
void * ioctx,
libxml-encoding.html#xmlCharEncodingHandlerPtr
xmlCharEncodingHandlerPtr
encoder)
Create a buffered output for the progressive saving to an I/O handler
iowrite
:
an I/O write function
ioclose
:
an I/O close function
ioctx
:
an I/O handler
encoder
:
the charset encoding if known
Returns
:
the new parser output or NULL
Function: xmlOutputBufferFlush
int	xmlOutputBufferFlush		(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out)
flushes the output I/O channel
out
:
a buffered output
Returns
:
the number of byte written or -1 in case of error.
Function: xmlOutputBufferWrite
int	xmlOutputBufferWrite		(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out,
int len,
const char * buf)
Write the content of the array in the output I/O buffer This routine handle the I18N transcoding from internal UTF-8 The buffer is lossless, i.e. will store in case of partial or delayed writes.
out
:
a buffered parser output
len
:
the size in bytes of the array.
buf
:
an char array
Returns
:
the number of chars immediately written, or -1 in case of error.
Function: xmlOutputBufferWriteEscape
int	xmlOutputBufferWriteEscape	(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out,
const
libxml-xmlstring.html#xmlChar
xmlChar
* str,
libxml-encoding.html#xmlCharEncodingOutputFunc
xmlCharEncodingOutputFunc
escaping)
Write the content of the string in the output I/O buffer This routine escapes the caracters and then handle the I18N transcoding from internal UTF-8 The buffer is lossless, i.e. will store in case of partial or delayed writes.
out
:
a buffered parser output
str
:
a zero terminated UTF-8 string
escaping
:
an optional escaping function (or NULL)
Returns
:
the number of chars immediately written, or -1 in case of error.
Function: xmlOutputBufferWriteString
int	xmlOutputBufferWriteString	(
libxml-tree.html#xmlOutputBufferPtr
xmlOutputBufferPtr
out,
const char * str)
Write the content of the string in the output I/O buffer This routine handle the I18N transcoding from internal UTF-8 The buffer is lossless, i.e. will store in case of partial or delayed writes.
out
:
a buffered parser output
str
:
a zero terminated C string
Returns
:
the number of chars immediately written, or -1 in case of error.
Function type: xmlOutputCloseCallback
Function type: xmlOutputCloseCallback
int	xmlOutputCloseCallback		(void * context)
Callback used in the I/O Output API to close the resource
context
:
an Output context
Returns
:
0 or -1 in case of error
Function type: xmlOutputMatchCallback
Function type: xmlOutputMatchCallback
int	xmlOutputMatchCallback		(char const * filename)
Callback used in the I/O Output API to detect if the current handler can provide output fonctionnalities for this resource.
filename
:
the filename or URI
Returns
:
1 if yes and 0 if another Output module should be used
Function type: xmlOutputOpenCallback
Function type: xmlOutputOpenCallback
void *	xmlOutputOpenCallback		(char const * filename)
Callback used in the I/O Output API to open the resource
filename
:
the filename or URI
Returns
:
an Output context or NULL in case or error
Function type: xmlOutputWriteCallback
Function type: xmlOutputWriteCallback
int	xmlOutputWriteCallback		(void * context,
const char * buffer,
int len)
Callback used in the I/O Output API to write to the resource
context
:
an Output context
buffer
:
the buffer of data to write
len
:
the length of the buffer in bytes
Returns
:
the number of bytes written or -1 in case of error
Function: xmlParserGetDirectory
char *	xmlParserGetDirectory		(const char * filename)
lookup the directory for that file
filename
:
the path to a file
Returns
:
a new allocated string containing the directory, or NULL.
Function: xmlParserInputBufferCreateFd
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
xmlParserInputBufferCreateFd	(int fd,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
Create a buffered parser input for the progressive parsing for the input from a file descriptor
fd
:
a file descriptor number
enc
:
the charset encoding if known
Returns
:
the new parser input or NULL
Function: xmlParserInputBufferCreateFile
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
xmlParserInputBufferCreateFile	(FILE * file,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
Create a buffered parser input for the progressive parsing of a FILE * buffered C I/O
file
:
a FILE*
enc
:
the charset encoding if known
Returns
:
the new parser input or NULL
Function: xmlParserInputBufferCreateFilename
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
xmlParserInputBufferCreateFilename	(const char * URI,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
Create a buffered parser input for the progressive parsing of a file If filename is "-' then we use stdin as the input. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. Do an encoding check if enc ==
libxml-encoding.html#XML_CHAR_ENCODING_NONE
XML_CHAR_ENCODING_NONE
URI
:
a C string containing the URI or filename
enc
:
the charset encoding if known
Returns
:
the new parser input or NULL
Function: xmlParserInputBufferCreateIO
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
xmlParserInputBufferCreateIO	(
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
ioread,
libxml-xmlIO.html#xmlInputCloseCallback
xmlInputCloseCallback
ioclose,
void * ioctx,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
Create a buffered parser input for the progressive parsing for the input from an I/O handler
ioread
:
an I/O read function
ioclose
:
an I/O close function
ioctx
:
an I/O handler
enc
:
the charset encoding if known
Returns
:
the new parser input or NULL
Function: xmlParserInputBufferCreateMem
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
xmlParserInputBufferCreateMem	(const char * mem,
int size,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
Create a buffered parser input for the progressive parsing for the input from a memory area.
mem
:
the memory input
size
:
the length of the memory block
enc
:
the charset encoding if known
Returns
:
the new parser input or NULL
Function: xmlParserInputBufferCreateStatic
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
xmlParserInputBufferCreateStatic	(const char * mem,
int size,
libxml-encoding.html#xmlCharEncoding
xmlCharEncoding
enc)
Create a buffered parser input for the progressive parsing for the input from an immutable memory area. This will not copy the memory area to the buffer, but the memory is expected to be available until the end of the parsing, this is useful for example when using mmap'ed file.
mem
:
the memory input
size
:
the length of the memory block
enc
:
the charset encoding if known
Returns
:
the new parser input or NULL
Function: xmlParserInputBufferGrow
int	xmlParserInputBufferGrow	(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
in,
int len)
Grow up the content of the input buffer, the old data are preserved This routine handle the I18N transcoding to internal UTF-8 This routine is used when operating the parser in normal (pull) mode TODO: one should be able to remove one extra copy by copying directly onto in->buffer or in->raw
in
:
a buffered parser input
len
:
indicative value of the amount of chars to read
Returns
:
the number of chars read and stored in the buffer, or -1 in case of error.
Function: xmlParserInputBufferPush
int	xmlParserInputBufferPush	(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
in,
int len,
const char * buf)
Push the content of the arry in the input buffer This routine handle the I18N transcoding to internal UTF-8 This is used when operating the parser in progressive (push) mode.
in
:
a buffered parser input
len
:
the size in bytes of the array.
buf
:
an char array
Returns
:
the number of chars read and stored in the buffer, or -1 in case of error.
Function: xmlParserInputBufferRead
int	xmlParserInputBufferRead	(
libxml-tree.html#xmlParserInputBufferPtr
xmlParserInputBufferPtr
in,
int len)
Refresh the content of the input buffer, the old data are considered consumed This routine handle the I18N transcoding to internal UTF-8
in
:
a buffered parser input
len
:
indicative value of the amount of chars to read
Returns
:
the number of chars read and stored in the buffer, or -1 in case of error.
Function: xmlPopInputCallbacks
int	xmlPopInputCallbacks		(void)
Clear the top input callback from the input stack. this includes the compiled-in I/O.
Returns
:
the number of input callback registered or -1 in case of error.
Function: xmlRegisterDefaultInputCallbacks
void	xmlRegisterDefaultInputCallbacks	(void)
Registers the default compiled-in I/O handlers.
Function: xmlRegisterDefaultOutputCallbacks
void	xmlRegisterDefaultOutputCallbacks	(void)
Registers the default compiled-in I/O handlers.
Function: xmlRegisterHTTPPostCallbacks
void	xmlRegisterHTTPPostCallbacks	(void)
By default, libxml submits HTTP output requests using the "PUT" method. Calling this method changes the HTTP output method to use the "POST" method instead.
Function: xmlRegisterInputCallbacks
int	xmlRegisterInputCallbacks	(
libxml-xmlIO.html#xmlInputMatchCallback
xmlInputMatchCallback
matchFunc,
libxml-xmlIO.html#xmlInputOpenCallback
xmlInputOpenCallback
openFunc,
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
readFunc,
libxml-xmlIO.html#xmlInputCloseCallback
xmlInputCloseCallback
closeFunc)
Register a new set of I/O callback for handling parser input.
matchFunc
:
the
libxml-xmlIO.html#xmlInputMatchCallback
xmlInputMatchCallback
openFunc
:
the
libxml-xmlIO.html#xmlInputOpenCallback
xmlInputOpenCallback
readFunc
:
the
libxml-xmlIO.html#xmlInputReadCallback
xmlInputReadCallback
closeFunc
:
the
libxml-xmlIO.html#xmlInputCloseCallback
xmlInputCloseCallback
Returns
:
the registered handler number or -1 in case of error
Function: xmlRegisterOutputCallbacks
int	xmlRegisterOutputCallbacks	(
libxml-xmlIO.html#xmlOutputMatchCallback
xmlOutputMatchCallback
matchFunc,
libxml-xmlIO.html#xmlOutputOpenCallback
xmlOutputOpenCallback
openFunc,
libxml-xmlIO.html#xmlOutputWriteCallback
xmlOutputWriteCallback
writeFunc,
libxml-xmlIO.html#xmlOutputCloseCallback
xmlOutputCloseCallback
closeFunc)
Register a new set of I/O callback for handling output.
matchFunc
:
the
libxml-xmlIO.html#xmlOutputMatchCallback
xmlOutputMatchCallback
openFunc
:
the
libxml-xmlIO.html#xmlOutputOpenCallback
xmlOutputOpenCallback
writeFunc
:
the
libxml-xmlIO.html#xmlOutputWriteCallback
xmlOutputWriteCallback
closeFunc
:
the
libxml-xmlIO.html#xmlOutputCloseCallback
xmlOutputCloseCallback
Returns
:
the registered handler number or -1 in case of error
../bugs.html
Daniel Veillard
