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 entities 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-encoding.html
Prev
libxml-encoding.html
encoding
index.html
Up
index.html
API documentation
../index.html
Home
../index.html
The XML C parser and toolkit of Gnome
libxml-globals.html
globals
libxml-globals.html
Next
this module provides some of the entity API needed for the parser and applications.
Table of Contents
Structure
#xmlEntitiesTable
xmlEntitiesTable
struct _xmlHashTable
The content of this structure is not made public by the API.
Typedef
libxml-entities.html#xmlEntitiesTable
xmlEntitiesTable
*
xmlEntitiesTablePtr
Enum
#xmlEntityType
xmlEntityType
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
#xmlAddDocEntity
xmlAddDocEntity
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name,
int type,
const
libxml-xmlstring.html#xmlChar
xmlChar
* ExternalID,
const
libxml-xmlstring.html#xmlChar
xmlChar
* SystemID,
const
libxml-xmlstring.html#xmlChar
xmlChar
* content)
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
#xmlAddDtdEntity
xmlAddDtdEntity
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name,
int type,
const
libxml-xmlstring.html#xmlChar
xmlChar
* ExternalID,
const
libxml-xmlstring.html#xmlChar
xmlChar
* SystemID,
const
libxml-xmlstring.html#xmlChar
xmlChar
* content)
void
#xmlCleanupPredefinedEntities
xmlCleanupPredefinedEntities
(void)
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
#xmlCopyEntitiesTable
xmlCopyEntitiesTable
(
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
table)
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
#xmlCreateEntitiesTable
xmlCreateEntitiesTable
(void)
void
#xmlDumpEntitiesTable
xmlDumpEntitiesTable
(
libxml-tree.html#xmlBufferPtr
xmlBufferPtr
buf,
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
table)
void
#xmlDumpEntityDecl
xmlDumpEntityDecl
(
libxml-tree.html#xmlBufferPtr
xmlBufferPtr
buf,
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
ent)
const
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlEncodeEntities
xmlEncodeEntities
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* input)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlEncodeEntitiesReentrant
xmlEncodeEntitiesReentrant
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* input)
libxml-xmlstring.html#xmlChar
xmlChar
*
#xmlEncodeSpecialChars
xmlEncodeSpecialChars
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* input)
void
#xmlFreeEntitiesTable
xmlFreeEntitiesTable
(
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
table)
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
#xmlGetDocEntity
xmlGetDocEntity
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
#xmlGetDtdEntity
xmlGetDtdEntity
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
#xmlGetParameterEntity
xmlGetParameterEntity
(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
#xmlGetPredefinedEntity
xmlGetPredefinedEntity
(const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
void
#xmlInitializePredefinedEntities
xmlInitializePredefinedEntities
(void)
Description
Structure xmlEntitiesTable
Structure xmlEntitiesTable
struct _xmlHashTable {
The content of this structure is not made public by the API.
}
Enum
xmlEntityType
Enum xmlEntityType {
XML_INTERNAL_GENERAL_ENTITY
= 1
XML_EXTERNAL_GENERAL_PARSED_ENTITY
= 2
XML_EXTERNAL_GENERAL_UNPARSED_ENTITY
= 3
XML_INTERNAL_PARAMETER_ENTITY
= 4
XML_EXTERNAL_PARAMETER_ENTITY
= 5
XML_INTERNAL_PREDEFINED_ENTITY
= 6
}
Function: xmlAddDocEntity
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
xmlAddDocEntity		(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name,
int type,
const
libxml-xmlstring.html#xmlChar
xmlChar
* ExternalID,
const
libxml-xmlstring.html#xmlChar
xmlChar
* SystemID,
const
libxml-xmlstring.html#xmlChar
xmlChar
* content)
Register a new entity for this document.
doc
:
the document
name
:
the entity name
type
:
the entity type XML_xxx_yyy_ENTITY
ExternalID
:
the entity external ID if available
SystemID
:
the entity system ID if available
content
:
the entity content
Returns
:
a pointer to the entity or NULL in case of error
Function: xmlAddDtdEntity
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
xmlAddDtdEntity		(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name,
int type,
const
libxml-xmlstring.html#xmlChar
xmlChar
* ExternalID,
const
libxml-xmlstring.html#xmlChar
xmlChar
* SystemID,
const
libxml-xmlstring.html#xmlChar
xmlChar
* content)
Register a new entity for this document DTD external subset.
doc
:
the document
name
:
the entity name
type
:
the entity type XML_xxx_yyy_ENTITY
ExternalID
:
the entity external ID if available
SystemID
:
the entity system ID if available
content
:
the entity content
Returns
:
a pointer to the entity or NULL in case of error
Function: xmlCleanupPredefinedEntities
void	xmlCleanupPredefinedEntities	(void)
Cleanup up the predefined entities table. Deprecated call
Function: xmlCopyEntitiesTable
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
xmlCopyEntitiesTable	(
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
table)
Build a copy of an entity table.
table
:
An entity table
Returns
:
the new
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
or NULL in case of error.
Function: xmlCreateEntitiesTable
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
xmlCreateEntitiesTable	(void)
create and initialize an empty entities hash table. This really doesn't make sense and should be deprecated
Returns
:
the
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
just created or NULL in case of error.
Function: xmlDumpEntitiesTable
void	xmlDumpEntitiesTable		(
libxml-tree.html#xmlBufferPtr
xmlBufferPtr
buf,
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
table)
This will dump the content of the entity table as an XML DTD definition
buf
:
An XML buffer.
table
:
An entity table
Function: xmlDumpEntityDecl
void	xmlDumpEntityDecl		(
libxml-tree.html#xmlBufferPtr
xmlBufferPtr
buf,
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
ent)
This will dump the content of the entity table as an XML DTD definition
buf
:
An XML buffer.
ent
:
An entity table
Function: xmlEncodeEntities
const
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlEncodeEntities	(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* input)
TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary compatibility People must migrate their code to
libxml-entities.html#xmlEncodeEntitiesReentrant
xmlEncodeEntitiesReentrant
! This routine will issue a warning when encountered.
doc
:
the document containing the string
input
:
A string to convert to XML.
Returns
:
NULL
Function: xmlEncodeEntitiesReentrant
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlEncodeEntitiesReentrant	(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* input)
Do a global encoding of a string, replacing the predefined entities and non ASCII values with their entities and CharRef counterparts. Contrary to xmlEncodeEntities, this routine is reentrant, and result must be deallocated.
doc
:
the document containing the string
input
:
A string to convert to XML.
Returns
:
A newly allocated string with the substitution done.
Function: xmlEncodeSpecialChars
libxml-xmlstring.html#xmlChar
xmlChar
*	xmlEncodeSpecialChars	(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* input)
Do a global encoding of a string, replacing the predefined entities this routine is reentrant, and result must be deallocated.
doc
:
the document containing the string
input
:
A string to convert to XML.
Returns
:
A newly allocated string with the substitution done.
Function: xmlFreeEntitiesTable
void	xmlFreeEntitiesTable		(
libxml-entities.html#xmlEntitiesTablePtr
xmlEntitiesTablePtr
table)
Deallocate the memory used by an entities hash table.
table
:
An entity table
Function: xmlGetDocEntity
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
xmlGetDocEntity		(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
Do an entity lookup in the document entity hash table and
doc
:
the document referencing the entity
name
:
the entity name
Returns
:
the corresponding entity, otherwise a lookup is done in the predefined entities too. Returns A pointer to the entity structure or NULL if not found.
Function: xmlGetDtdEntity
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
xmlGetDtdEntity		(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
Do an entity lookup in the DTD entity hash table and
doc
:
the document referencing the entity
name
:
the entity name
Returns
:
the corresponding entity, if found. Note: the first argument is the document node, not the DTD node. Returns A pointer to the entity structure or NULL if not found.
Function: xmlGetParameterEntity
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
xmlGetParameterEntity	(
libxml-tree.html#xmlDocPtr
xmlDocPtr
doc,
const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
Do an entity lookup in the internal and external subsets and
doc
:
the document referencing the entity
name
:
the entity name
Returns
:
the corresponding parameter entity, if found. Returns A pointer to the entity structure or NULL if not found.
Function: xmlGetPredefinedEntity
libxml-tree.html#xmlEntityPtr
xmlEntityPtr
xmlGetPredefinedEntity	(const
libxml-xmlstring.html#xmlChar
xmlChar
* name)
Check whether this name is an predefined entity.
name
:
the entity name
Returns
:
NULL if not, otherwise the entity
Function: xmlInitializePredefinedEntities
void	xmlInitializePredefinedEntities	(void)
Set up the predefined entities. Deprecated call
../bugs.html
Daniel Veillard
