Blame doc/html/libxml-SAX.html

Packit Service a31ea6
Packit Service a31ea6
Packit Service a31ea6
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="SHORTCUT ICON" href="/favicon.ico" /><style type="text/css">
Packit Service a31ea6
TD {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6
BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
Packit Service a31ea6
H1 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6
H2 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6
H3 {font-family: Verdana,Arial,Helvetica}
Packit Service a31ea6
A:link, A:visited, A:active { text-decoration: underline }
Packit Service a31ea6
</style><style type="text/css">
Packit Service a31ea6
      div.deprecated pre.programlisting {border-style: double;border-color:red}
Packit Service a31ea6
      pre.programlisting {border-style: double;background: #EECFA1}
Packit Service a31ea6
    </style><title>Module SAX from libxml2</title></head><body bgcolor="#8b7765" text="#000000" link="#a06060" vlink="#000000">
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module SAX from libxml2

<center>API Menu</center>
<form action="../search.php" enctype="application/x-www-form-urlencoded" method="get"><input name="query" type="text" size="20" value="" /><input name="submit" type="submit" value="Search ..." /></form>
<center>API Indexes</center>
<center>Related links</center>

This module is deprecated

DEPRECATED set of SAX version 1 interfaces used to build the DOM tree.

Table of Contents

void	comment			(void * ctx, 
const xmlChar * value)
Packit Service a31ea6
int	checkNamespace			(void * ctx, 
xmlChar * namespace)
Packit Service a31ea6
int	getColumnNumber			(void * ctx)
Packit Service a31ea6
void	entityDecl			(void * ctx, 
const xmlChar * name,
int type,
const xmlChar * publicId,
const xmlChar * systemId,
xmlChar * content)
Packit Service a31ea6
void	attribute			(void * ctx, 
const xmlChar * fullname,
const xmlChar * value)
Packit Service a31ea6
xmlNsPtr	getNamespace		(void * ctx)
Packit Service a31ea6
void	setDocumentLocator		(void * ctx, 
xmlSAXLocatorPtr loc)
Packit Service a31ea6
void	initxmlDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr, 
int warning)
Packit Service a31ea6
void	ignorableWhitespace		(void * ctx, 
const xmlChar * ch,
int len)
Packit Service a31ea6
int	hasExternalSubset		(void * ctx)
Packit Service a31ea6
void	unparsedEntityDecl		(void * ctx, 
const xmlChar * name,
const xmlChar * publicId,
const xmlChar * systemId,
const xmlChar * notationName)
Packit Service a31ea6
void	globalNamespace			(void * ctx, 
const xmlChar * href,
const xmlChar * prefix)
Packit Service a31ea6
int	hasInternalSubset		(void * ctx)
Packit Service a31ea6
void	reference			(void * ctx, 
const xmlChar * name)
Packit Service a31ea6
void	notationDecl			(void * ctx, 
const xmlChar * name,
const xmlChar * publicId,
const xmlChar * systemId)
Packit Service a31ea6
const xmlChar *	getSystemId		(void * ctx)
Packit Service a31ea6
void	externalSubset			(void * ctx, 
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID)
Packit Service a31ea6
xmlParserInputPtr	resolveEntity	(void * ctx, 
const xmlChar * publicId,
const xmlChar * systemId)
Packit Service a31ea6
void	startDocument			(void * ctx)
Packit Service a31ea6
void	setNamespace			(void * ctx, 
const xmlChar * name)
Packit Service a31ea6
void	cdataBlock			(void * ctx, 
const xmlChar * value,
int len)
Packit Service a31ea6
const xmlChar *	getPublicId		(void * ctx)
Packit Service a31ea6
void	inithtmlDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr)
Packit Service a31ea6
void	processingInstruction		(void * ctx, 
const xmlChar * target,
const xmlChar * data)
Packit Service a31ea6
void	endElement			(void * ctx, 
const xmlChar * name)
Packit Service a31ea6
void	namespaceDecl			(void * ctx, 
const xmlChar * href,
const xmlChar * prefix)
Packit Service a31ea6
void	initdocbDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr)
Packit Service a31ea6
xmlEntityPtr	getEntity		(void * ctx, 
const xmlChar * name)
Packit Service a31ea6
void	characters			(void * ctx, 
const xmlChar * ch,
int len)
Packit Service a31ea6
void	elementDecl			(void * ctx, 
const xmlChar * name,
int type,
xmlElementContentPtr content)
Packit Service a31ea6
void	startElement			(void * ctx, 
const xmlChar * fullname,
const xmlChar ** atts)
Packit Service a31ea6
xmlEntityPtr	getParameterEntity	(void * ctx, 
const xmlChar * name)
Packit Service a31ea6
void	attributeDecl			(void * ctx, 
const xmlChar * elem,
const xmlChar * fullname,
int type,
int def,
const xmlChar * defaultValue,
xmlEnumerationPtr tree)
Packit Service a31ea6
int	isStandalone			(void * ctx)
Packit Service a31ea6
void	internalSubset			(void * ctx, 
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID)
Packit Service a31ea6
void	endDocument			(void * ctx)
Packit Service a31ea6
int	getLineNumber			(void * ctx)
Packit Service a31ea6

Description

Packit Service a31ea6

Function: comment

void	comment			(void * ctx, 
const xmlChar * value)
Packit Service a31ea6

A comment has been parsed. DEPRECATED: use xmlSAX2Comment()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>value</tt>:the comment content

Function: checkNamespace

int	checkNamespace			(void * ctx, 
xmlChar * namespace)
Packit Service a31ea6

Check that the current element namespace is the same as the one read upon parsing. DEPRECATED

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>namespace</tt>:the namespace to check against
<tt>Returns</tt>:1 if true 0 otherwise

Function: getColumnNumber

int	getColumnNumber			(void * ctx)
Packit Service a31ea6

Provide the column number of the current parsing point. DEPRECATED: use xmlSAX2GetColumnNumber()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>Returns</tt>:an int

Function: entityDecl

void	entityDecl			(void * ctx, 
const xmlChar * name,
int type,
const xmlChar * publicId,
const xmlChar * systemId,
xmlChar * content)
Packit Service a31ea6

An entity definition has been parsed DEPRECATED: use xmlSAX2EntityDecl()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:the entity name
<tt>type</tt>:the entity type
<tt>publicId</tt>:The public ID of the entity
<tt>systemId</tt>:The system ID of the entity
<tt>content</tt>:the entity value (without processing).

Function: attribute

void	attribute			(void * ctx, 
const xmlChar * fullname,
const xmlChar * value)
Packit Service a31ea6

Handle an attribute that has been read by the parser. The default handling is to convert the attribute into an DOM subtree and past it in a new xmlAttr element added to the element. DEPRECATED: use xmlSAX2Attribute()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>fullname</tt>:The attribute name, including namespace prefix
<tt>value</tt>:The attribute value

Function: getNamespace

xmlNsPtr	getNamespace		(void * ctx)
Packit Service a31ea6

Get the current element namespace. DEPRECATED

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>Returns</tt>:the xmlNsPtr or NULL if none

Function: setDocumentLocator

void	setDocumentLocator		(void * ctx, 
xmlSAXLocatorPtr loc)
Packit Service a31ea6

Receive the document locator at startup, actually xmlDefaultSAXLocator Everything is available on the context, so this is useless in our case. DEPRECATED

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>loc</tt>:A SAX Locator

Function: initxmlDefaultSAXHandler

void	initxmlDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr, 
int warning)
Packit Service a31ea6

Initialize the default XML SAX version 1 handler DEPRECATED: use xmlSAX2InitDefaultSAXHandler() for the new SAX2 blocks

Packit Service a31ea6
<tt>hdlr</tt>:the SAX handler
<tt>warning</tt>:flag if non-zero sets the handler warning procedure

Function: ignorableWhitespace

void	ignorableWhitespace		(void * ctx, 
const xmlChar * ch,
int len)
Packit Service a31ea6

receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use characters DEPRECATED: use xmlSAX2IgnorableWhitespace()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>ch</tt>:a xmlChar string
<tt>len</tt>:the number of xmlChar

Function: hasExternalSubset

int	hasExternalSubset		(void * ctx)
Packit Service a31ea6

Does this document has an external subset DEPRECATED: use xmlSAX2HasExternalSubset()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>Returns</tt>:1 if true

Function: unparsedEntityDecl

void	unparsedEntityDecl		(void * ctx, 
const xmlChar * name,
const xmlChar * publicId,
const xmlChar * systemId,
const xmlChar * notationName)
Packit Service a31ea6

What to do when an unparsed entity declaration is parsed DEPRECATED: use xmlSAX2UnparsedEntityDecl()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:The name of the entity
<tt>publicId</tt>:The public ID of the entity
<tt>systemId</tt>:The system ID of the entity
<tt>notationName</tt>:the name of the notation

Function: globalNamespace

void	globalNamespace			(void * ctx, 
const xmlChar * href,
const xmlChar * prefix)
Packit Service a31ea6

An old global namespace has been parsed. DEPRECATED

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>href</tt>:the namespace associated URN
<tt>prefix</tt>:the namespace prefix

Function: hasInternalSubset

int	hasInternalSubset		(void * ctx)
Packit Service a31ea6

Does this document has an internal subset DEPRECATED: use xmlSAX2HasInternalSubset()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>Returns</tt>:1 if true

Function: reference

void	reference			(void * ctx, 
const xmlChar * name)
Packit Service a31ea6

called when an entity reference is detected. DEPRECATED: use xmlSAX2Reference()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:The entity name

Function: notationDecl

void	notationDecl			(void * ctx, 
const xmlChar * name,
const xmlChar * publicId,
const xmlChar * systemId)
Packit Service a31ea6

What to do when a notation declaration has been parsed. DEPRECATED: use xmlSAX2NotationDecl()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:The name of the notation
<tt>publicId</tt>:The public ID of the entity
<tt>systemId</tt>:The system ID of the entity

Function: getSystemId

const xmlChar *	getSystemId		(void * ctx)
Packit Service a31ea6

Provides the system ID, basically URL or filename e.g. http://www.sgmlsource.com/dtds/memo.dtd DEPRECATED: use xmlSAX2GetSystemId()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>Returns</tt>:a xmlChar *

Function: externalSubset

void	externalSubset			(void * ctx, 
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID)
Packit Service a31ea6

Callback on external subset declaration. DEPRECATED: use xmlSAX2ExternalSubset()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:the root element name
<tt>ExternalID</tt>:the external ID
<tt>SystemID</tt>:the SYSTEM ID (e.g. filename or URL)

Function: resolveEntity

xmlParserInputPtr	resolveEntity	(void * ctx, 
const xmlChar * publicId,
const xmlChar * systemId)
Packit Service a31ea6

The entity loader, to control the loading of external entities, the application can either: - override this resolveEntity() callback in the SAX block - or better use the xmlSetExternalEntityLoader() function to set up it's own entity resolution routine DEPRECATED: use xmlSAX2ResolveEntity()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>publicId</tt>:The public ID of the entity
<tt>systemId</tt>:The system ID of the entity
<tt>Returns</tt>:the xmlParserInputPtr if inlined or NULL for DOM behaviour.

Function: startDocument

void	startDocument			(void * ctx)
Packit Service a31ea6

called when the document start being processed. DEPRECATED: use xmlSAX2StartDocument()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)

Function: setNamespace

void	setNamespace			(void * ctx, 
const xmlChar * name)
Packit Service a31ea6

Set the current element namespace. DEPRECATED

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:the namespace prefix

Function: cdataBlock

void	cdataBlock			(void * ctx, 
const xmlChar * value,
int len)
Packit Service a31ea6

called when a pcdata block has been parsed DEPRECATED: use xmlSAX2CDataBlock()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>value</tt>:The pcdata content
<tt>len</tt>:the block length

Function: getPublicId

const xmlChar *	getPublicId		(void * ctx)
Packit Service a31ea6

Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN" DEPRECATED: use xmlSAX2GetPublicId()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>Returns</tt>:a xmlChar *

Function: inithtmlDefaultSAXHandler

void	inithtmlDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr)
Packit Service a31ea6

Initialize the default HTML SAX version 1 handler DEPRECATED: use xmlSAX2InitHtmlDefaultSAXHandler() for the new SAX2 blocks

Packit Service a31ea6
<tt>hdlr</tt>:the SAX handler

Function: processingInstruction

void	processingInstruction		(void * ctx, 
const xmlChar * target,
const xmlChar * data)
Packit Service a31ea6

A processing instruction has been parsed. DEPRECATED: use xmlSAX2ProcessingInstruction()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>target</tt>:the target name
<tt>data</tt>:the PI data's

Function: endElement

void	endElement			(void * ctx, 
const xmlChar * name)
Packit Service a31ea6

called when the end of an element has been detected. DEPRECATED: use xmlSAX2EndElement()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:The element name

Function: namespaceDecl

void	namespaceDecl			(void * ctx, 
const xmlChar * href,
const xmlChar * prefix)
Packit Service a31ea6

A namespace has been parsed. DEPRECATED

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>href</tt>:the namespace associated URN
<tt>prefix</tt>:the namespace prefix

Function: initdocbDefaultSAXHandler

void	initdocbDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr)
Packit Service a31ea6

Initialize the default DocBook SAX version 1 handler DEPRECATED: use xmlSAX2InitDocbDefaultSAXHandler() for the new SAX2 blocks

Packit Service a31ea6
<tt>hdlr</tt>:the SAX handler

Function: getEntity

xmlEntityPtr	getEntity		(void * ctx, 
const xmlChar * name)
Packit Service a31ea6

Get an entity by name DEPRECATED: use xmlSAX2GetEntity()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:The entity name
<tt>Returns</tt>:the xmlEntityPtr if found.

Function: characters

void	characters			(void * ctx, 
const xmlChar * ch,
int len)
Packit Service a31ea6

receiving some chars from the parser. DEPRECATED: use xmlSAX2Characters()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>ch</tt>:a xmlChar string
<tt>len</tt>:the number of xmlChar

Function: elementDecl

void	elementDecl			(void * ctx, 
const xmlChar * name,
int type,
xmlElementContentPtr content)
Packit Service a31ea6

An element definition has been parsed DEPRECATED: use xmlSAX2ElementDecl()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:the element name
<tt>type</tt>:the element type
<tt>content</tt>:the element value tree

Function: startElement

void	startElement			(void * ctx, 
const xmlChar * fullname,
const xmlChar ** atts)
Packit Service a31ea6

called when an opening tag has been processed. DEPRECATED: use xmlSAX2StartElement()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>fullname</tt>:The element name, including namespace prefix
<tt>atts</tt>:An array of name/value attributes pairs, NULL terminated

Function: getParameterEntity

xmlEntityPtr	getParameterEntity	(void * ctx, 
const xmlChar * name)
Packit Service a31ea6

Get a parameter entity by name DEPRECATED: use xmlSAX2GetParameterEntity()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:The entity name
<tt>Returns</tt>:the xmlEntityPtr if found.

Function: attributeDecl

void	attributeDecl			(void * ctx, 
const xmlChar * elem,
const xmlChar * fullname,
int type,
int def,
const xmlChar * defaultValue,
xmlEnumerationPtr tree)
Packit Service a31ea6

An attribute definition has been parsed DEPRECATED: use xmlSAX2AttributeDecl()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>elem</tt>:the name of the element
<tt>fullname</tt>:the attribute name
<tt>type</tt>:the attribute type
<tt>def</tt>:the type of default value
<tt>defaultValue</tt>:the attribute default value
<tt>tree</tt>:the tree of enumerated value set

Function: isStandalone

int	isStandalone			(void * ctx)
Packit Service a31ea6

Is this document tagged standalone ? DEPRECATED: use xmlSAX2IsStandalone()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>Returns</tt>:1 if true

Function: internalSubset

void	internalSubset			(void * ctx, 
const xmlChar * name,
const xmlChar * ExternalID,
const xmlChar * SystemID)
Packit Service a31ea6

Callback on internal subset declaration. DEPRECATED: use xmlSAX2InternalSubset()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>name</tt>:the root element name
<tt>ExternalID</tt>:the external ID
<tt>SystemID</tt>:the SYSTEM ID (e.g. filename or URL)

Function: endDocument

void	endDocument			(void * ctx)
Packit Service a31ea6

called when the document end has been detected. DEPRECATED: use xmlSAX2EndDocument()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)

Function: getLineNumber

int	getLineNumber			(void * ctx)
Packit Service a31ea6

Provide the line number of the current parsing point. DEPRECATED: use xmlSAX2GetLineNumber()

Packit Service a31ea6
<tt>ctx</tt>:the user data (XML parser context)
<tt>Returns</tt>:an int

Daniel Veillard

</body></html>