http://swpat.ffii.org/Action against software patents http://www.gnome.org/Gnome2 Logo http://www.w3.org/StatusW3C Logo http://www.redhat.com/Red Hat Logo http://xmlsoft.org/Made with Libxml2 Logo 
Module entities from libxml2
API Menu ../index.htmlMain Menu ../docs.htmlDeveloper Menu ../examples/index.htmlCode Examples index.htmlAPI Menu libxml-parser.htmlParser API libxml-tree.htmlTree API libxml-xmlreader.htmlReader API ../guidelines.htmlXML Guidelines ../ChangeLog.htmlChangeLog API Indexes ../APIchunk0.htmlAlphabetic ../APIconstructors.htmlConstructors ../APIfunctions.htmlFunctions/Types ../APIfiles.htmlModules ../APIsymbols.htmlSymbols 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/libxml2Solaris binaries http://www.explain.com.au/oss/libxml2xslt.htmlMacOsX binaries http://libxmlplusplus.sourceforge.net/C++ bindings http://www.zend.com/php5/articles/php5-xmlphp.php#Heading4PHP 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=libxml2Bug Tracker libxml-encoding.htmlPrev libxml-encoding.htmlencoding index.htmlUp index.htmlAPI documentation ../index.htmlHome ../index.htmlThe XML C parser and toolkit of Gnome libxml-globals.htmlglobals libxml-globals.htmlNext this module provides some of the entity API needed for the parser and applications. 
Table of Contents
Structure #xmlEntitiesTablexmlEntitiesTable struct _xmlHashTable
The content of this structure is not made public by the API.
Typedef libxml-entities.html#xmlEntitiesTablexmlEntitiesTable  * xmlEntitiesTablePtr Enum #xmlEntityTypexmlEntityType libxml-tree.html#xmlEntityPtrxmlEntityPtr 	#xmlAddDocEntityxmlAddDocEntity 		( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * name, 					 int type, 					 const libxml-xmlstring.html#xmlCharxmlChar  * ExternalID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * SystemID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * content) libxml-tree.html#xmlEntityPtrxmlEntityPtr 	#xmlAddDtdEntityxmlAddDtdEntity 		( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * name, 					 int type, 					 const libxml-xmlstring.html#xmlCharxmlChar  * ExternalID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * SystemID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * content)void	#xmlCleanupPredefinedEntitiesxmlCleanupPredefinedEntities 	(void) libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr 	#xmlCopyEntitiesTablexmlCopyEntitiesTable 	( libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr  table) libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr 	#xmlCreateEntitiesTablexmlCreateEntitiesTable 	(void)void	#xmlDumpEntitiesTablexmlDumpEntitiesTable 		( libxml-tree.html#xmlBufferPtrxmlBufferPtr  buf, 					 libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr  table)void	#xmlDumpEntityDeclxmlDumpEntityDecl 		( libxml-tree.html#xmlBufferPtrxmlBufferPtr  buf, 					 libxml-tree.html#xmlEntityPtrxmlEntityPtr  ent)const libxml-xmlstring.html#xmlCharxmlChar  *	#xmlEncodeEntitiesxmlEncodeEntities 	( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * input) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlEncodeEntitiesReentrantxmlEncodeEntitiesReentrant 	( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 						 const libxml-xmlstring.html#xmlCharxmlChar  * input) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlEncodeSpecialCharsxmlEncodeSpecialChars 	( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * input)void	#xmlFreeEntitiesTablexmlFreeEntitiesTable 		( libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr  table) libxml-tree.html#xmlEntityPtrxmlEntityPtr 	#xmlGetDocEntityxmlGetDocEntity 		( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * name) libxml-tree.html#xmlEntityPtrxmlEntityPtr 	#xmlGetDtdEntityxmlGetDtdEntity 		( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * name) libxml-tree.html#xmlEntityPtrxmlEntityPtr 	#xmlGetParameterEntityxmlGetParameterEntity 	( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * name) libxml-tree.html#xmlEntityPtrxmlEntityPtr 	#xmlGetPredefinedEntityxmlGetPredefinedEntity 	(const libxml-xmlstring.html#xmlCharxmlChar  * name)void	#xmlInitializePredefinedEntitiesxmlInitializePredefinedEntities 	(void)Description
Structure xmlEntitiesTable 
Structure xmlEntitiesTablestruct _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#xmlEntityPtrxmlEntityPtr 	xmlAddDocEntity		( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * name, 					 int type, 					 const libxml-xmlstring.html#xmlCharxmlChar  * ExternalID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * SystemID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * 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#xmlEntityPtrxmlEntityPtr 	xmlAddDtdEntity		( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * name, 					 int type, 					 const libxml-xmlstring.html#xmlCharxmlChar  * ExternalID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * SystemID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * 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#xmlEntitiesTablePtrxmlEntitiesTablePtr 	xmlCopyEntitiesTable	( libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr  table)Build a copy of an entity table.
table: An entity table Returns: the new libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr  or NULL in case of error. Function: xmlCreateEntitiesTable
libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr 	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#xmlEntitiesTablePtrxmlEntitiesTablePtr  just created or NULL in case of error. Function: xmlDumpEntitiesTable
void	xmlDumpEntitiesTable		( libxml-tree.html#xmlBufferPtrxmlBufferPtr  buf, 					 libxml-entities.html#xmlEntitiesTablePtrxmlEntitiesTablePtr  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#xmlBufferPtrxmlBufferPtr  buf, 					 libxml-tree.html#xmlEntityPtrxmlEntityPtr  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#xmlCharxmlChar  *	xmlEncodeEntities	( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * input)TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary compatibility People must migrate their code to libxml-entities.html#xmlEncodeEntitiesReentrantxmlEncodeEntitiesReentrant  ! 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#xmlCharxmlChar  *	xmlEncodeEntitiesReentrant	( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 						 const libxml-xmlstring.html#xmlCharxmlChar  * 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#xmlCharxmlChar  *	xmlEncodeSpecialChars	( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * 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#xmlEntitiesTablePtrxmlEntitiesTablePtr  table)Deallocate the memory used by an entities hash table.
table: An entity table Function: xmlGetDocEntity
libxml-tree.html#xmlEntityPtrxmlEntityPtr 	xmlGetDocEntity		( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * 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#xmlEntityPtrxmlEntityPtr 	xmlGetDtdEntity		( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * 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#xmlEntityPtrxmlEntityPtr 	xmlGetParameterEntity	( libxml-tree.html#xmlDocPtrxmlDocPtr  doc, 					 const libxml-xmlstring.html#xmlCharxmlChar  * 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#xmlEntityPtrxmlEntityPtr 	xmlGetPredefinedEntity	(const libxml-xmlstring.html#xmlCharxmlChar  * 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.htmlDaniel Veillard 
