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 catalog 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-c14n.htmlPrev libxml-c14n.htmlc14n index.htmlUp index.htmlAPI documentation ../index.htmlHome ../index.htmlThe XML C parser and toolkit of Gnome libxml-chvalid.htmlchvalid libxml-chvalid.htmlNext the catalog module implements the support for XML Catalogs and SGML catalogs 
Table of Contents
#define #XML_CATALOGS_NAMESPACEXML_CATALOGS_NAMESPACE #define #XML_CATALOG_PIXML_CATALOG_PI Structure #xmlCatalogxmlCatalog struct _xmlCatalog
The content of this structure is not made public by the API.
Enum #xmlCatalogAllowxmlCatalogAllow Enum #xmlCatalogPreferxmlCatalogPrefer Typedef libxml-catalog.html#xmlCatalogxmlCatalog  * xmlCatalogPtr int	#xmlACatalogAddxmlACatalogAdd 			( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 const libxml-xmlstring.html#xmlCharxmlChar  * type, 					 const libxml-xmlstring.html#xmlCharxmlChar  * orig, 					 const libxml-xmlstring.html#xmlCharxmlChar  * replace)void	#xmlACatalogDumpxmlACatalogDump 			( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 FILE * out)int	#xmlACatalogRemovexmlACatalogRemove 		( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 const libxml-xmlstring.html#xmlCharxmlChar  * value) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlACatalogResolvexmlACatalogResolve 	( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 const libxml-xmlstring.html#xmlCharxmlChar  * pubID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * sysID) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlACatalogResolvePublicxmlACatalogResolvePublic 	( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 						 const libxml-xmlstring.html#xmlCharxmlChar  * pubID) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlACatalogResolveSystemxmlACatalogResolveSystem 	( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 						 const libxml-xmlstring.html#xmlCharxmlChar  * sysID) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlACatalogResolveURIxmlACatalogResolveURI 	( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 const libxml-xmlstring.html#xmlCharxmlChar  * URI)int	#xmlCatalogAddxmlCatalogAdd 			(const libxml-xmlstring.html#xmlCharxmlChar  * type, 					 const libxml-xmlstring.html#xmlCharxmlChar  * orig, 					 const libxml-xmlstring.html#xmlCharxmlChar  * replace)void *	#xmlCatalogAddLocalxmlCatalogAddLocal 		(void * catalogs, 					 const libxml-xmlstring.html#xmlCharxmlChar  * URL)void	#xmlCatalogCleanupxmlCatalogCleanup 		(void)int	#xmlCatalogConvertxmlCatalogConvert 		(void)void	#xmlCatalogDumpxmlCatalogDump 			(FILE * out)void	#xmlCatalogFreeLocalxmlCatalogFreeLocal 		(void * catalogs) libxml-catalog.html#xmlCatalogAllowxmlCatalogAllow 	#xmlCatalogGetDefaultsxmlCatalogGetDefaults 	(void)const libxml-xmlstring.html#xmlCharxmlChar  *	#xmlCatalogGetPublicxmlCatalogGetPublic 	(const libxml-xmlstring.html#xmlCharxmlChar  * pubID)const libxml-xmlstring.html#xmlCharxmlChar  *	#xmlCatalogGetSystemxmlCatalogGetSystem 	(const libxml-xmlstring.html#xmlCharxmlChar  * sysID)int	#xmlCatalogIsEmptyxmlCatalogIsEmpty 		( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlCatalogLocalResolvexmlCatalogLocalResolve 	(void * catalogs, 					 const libxml-xmlstring.html#xmlCharxmlChar  * pubID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * sysID) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlCatalogLocalResolveURIxmlCatalogLocalResolveURI 	(void * catalogs, 						 const libxml-xmlstring.html#xmlCharxmlChar  * URI)int	#xmlCatalogRemovexmlCatalogRemove 		(const libxml-xmlstring.html#xmlCharxmlChar  * value) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlCatalogResolvexmlCatalogResolve 	(const libxml-xmlstring.html#xmlCharxmlChar  * pubID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * sysID) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlCatalogResolvePublicxmlCatalogResolvePublic 	(const libxml-xmlstring.html#xmlCharxmlChar  * pubID) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlCatalogResolveSystemxmlCatalogResolveSystem 	(const libxml-xmlstring.html#xmlCharxmlChar  * sysID) libxml-xmlstring.html#xmlCharxmlChar  *	#xmlCatalogResolveURIxmlCatalogResolveURI 	(const libxml-xmlstring.html#xmlCharxmlChar  * URI)int	#xmlCatalogSetDebugxmlCatalogSetDebug 		(int level) libxml-catalog.html#xmlCatalogPreferxmlCatalogPrefer 	#xmlCatalogSetDefaultPreferxmlCatalogSetDefaultPrefer 	( libxml-catalog.html#xmlCatalogPreferxmlCatalogPrefer  prefer)void	#xmlCatalogSetDefaultsxmlCatalogSetDefaults 		( libxml-catalog.html#xmlCatalogAllowxmlCatalogAllow  allow)int	#xmlConvertSGMLCatalogxmlConvertSGMLCatalog 		( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal)void	#xmlFreeCatalogxmlFreeCatalog 			( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal)void	#xmlInitializeCatalogxmlInitializeCatalog 		(void) libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr 	#xmlLoadACatalogxmlLoadACatalog 		(const char * filename)int	#xmlLoadCatalogxmlLoadCatalog 			(const char * filename)void	#xmlLoadCatalogsxmlLoadCatalogs 			(const char * pathss) libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr 	#xmlLoadSGMLSuperCatalogxmlLoadSGMLSuperCatalog 	(const char * filename) libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr 	#xmlNewCatalogxmlNewCatalog 		(int sgml) libxml-tree.html#xmlDocPtrxmlDocPtr 	#xmlParseCatalogFilexmlParseCatalogFile 	(const char * filename)Description
Macro: XML_CATALOGS_NAMESPACE
#define XML_CATALOGS_NAMESPACEThe namespace for the XML Catalogs elements.
Macro: XML_CATALOG_PI
#define XML_CATALOG_PIThe specific XML Catalog Processing Instuction name.
Structure xmlCatalog 
Structure xmlCatalogstruct _xmlCatalog {
The content of this structure is not made public by the API.
}
Enum xmlCatalogAllow 
Enum xmlCatalogAllow {
    
XML_CATA_ALLOW_NONE  = 0
    
XML_CATA_ALLOW_GLOBAL  = 1
    
XML_CATA_ALLOW_DOCUMENT  = 2
    
XML_CATA_ALLOW_ALL  = 3
}
Enum xmlCatalogPrefer 
Enum xmlCatalogPrefer {
    
XML_CATA_PREFER_NONE  = 0
    
XML_CATA_PREFER_PUBLIC  = 1
    
XML_CATA_PREFER_SYSTEM  = 2
}
Function: xmlACatalogAdd
int	xmlACatalogAdd			( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 const libxml-xmlstring.html#xmlCharxmlChar  * type, 					 const libxml-xmlstring.html#xmlCharxmlChar  * orig, 					 const libxml-xmlstring.html#xmlCharxmlChar  * replace)Add an entry in the catalog, it may overwrite existing but different entries.
catal: a Catalog type: the type of record to add to the catalog orig: the system, public or prefix to match replace: the replacement value for the match Returns: 0 if successful, -1 otherwise Function: xmlACatalogDump
void	xmlACatalogDump			( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 FILE * out)Dump the given catalog to the given file.
catal: a Catalog out: the file. Function: xmlACatalogRemove
int	xmlACatalogRemove		( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 const libxml-xmlstring.html#xmlCharxmlChar  * value)Remove an entry from the catalog
catal: a Catalog value: the value to remove Returns: the number of entries removed if successful, -1 otherwise Function: xmlACatalogResolve
libxml-xmlstring.html#xmlCharxmlChar  *	xmlACatalogResolve	( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 const libxml-xmlstring.html#xmlCharxmlChar  * pubID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * sysID)Do a complete resolution lookup of an External Identifier
catal: a Catalog pubID: the public ID string sysID: the system ID string Returns: the URI of the resource or NULL if not found, it must be freed by the caller. Function: xmlACatalogResolvePublic
libxml-xmlstring.html#xmlCharxmlChar  *	xmlACatalogResolvePublic	( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 						 const libxml-xmlstring.html#xmlCharxmlChar  * pubID)Try to lookup the catalog local libxml-SAX.html#referencereference  associated to a public ID in that catalog
catal: a Catalog pubID: the public ID string Returns: the local resource if found or NULL otherwise, the value returned must be freed by the caller. Function: xmlACatalogResolveSystem
libxml-xmlstring.html#xmlCharxmlChar  *	xmlACatalogResolveSystem	( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 						 const libxml-xmlstring.html#xmlCharxmlChar  * sysID)Try to lookup the catalog resource for a system ID
catal: a Catalog sysID: the system ID string Returns: the resource if found or NULL otherwise, the value returned must be freed by the caller. Function: xmlACatalogResolveURI
libxml-xmlstring.html#xmlCharxmlChar  *	xmlACatalogResolveURI	( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal, 					 const libxml-xmlstring.html#xmlCharxmlChar  * URI)Do a complete resolution lookup of an URI
catal: a Catalog URI: the URI Returns: the URI of the resource or NULL if not found, it must be freed by the caller. Function: xmlCatalogAdd
int	xmlCatalogAdd			(const libxml-xmlstring.html#xmlCharxmlChar  * type, 					 const libxml-xmlstring.html#xmlCharxmlChar  * orig, 					 const libxml-xmlstring.html#xmlCharxmlChar  * replace)Add an entry in the catalog, it may overwrite existing but different entries. If called before any other catalog routine, allows to override the default shared catalog put in place by xmlInitializeCatalog();
type: the type of record to add to the catalog orig: the system, public or prefix to match replace: the replacement value for the match Returns: 0 if successful, -1 otherwise Function: xmlCatalogAddLocal
void *	xmlCatalogAddLocal		(void * catalogs, 					 const libxml-xmlstring.html#xmlCharxmlChar  * URL)Add the new entry to the catalog list
catalogs: a document's list of catalogs URL: the URL to a new local catalog Returns: the updated list Function: xmlCatalogCleanup
void	xmlCatalogCleanup		(void)Free up all the memory associated with catalogs
Function: xmlCatalogConvert
int	xmlCatalogConvert		(void)Convert all the SGML catalog entries as XML ones
Returns: the number of entries converted if successful, -1 otherwise Function: xmlCatalogDump
void	xmlCatalogDump			(FILE * out)Dump all the global catalog content to the given file.
out: the file. Function: xmlCatalogFreeLocal
void	xmlCatalogFreeLocal		(void * catalogs)Free up the memory associated to the catalog list
catalogs: a document's list of catalogs Function: xmlCatalogGetDefaults
libxml-catalog.html#xmlCatalogAllowxmlCatalogAllow 	xmlCatalogGetDefaults	(void)Used to get the user preference w.r.t. to what catalogs should be accepted
Returns: the current libxml-catalog.html#xmlCatalogAllowxmlCatalogAllow  value Function: xmlCatalogGetPublic
const libxml-xmlstring.html#xmlCharxmlChar  *	xmlCatalogGetPublic	(const libxml-xmlstring.html#xmlCharxmlChar  * pubID)Try to lookup the catalog libxml-SAX.html#referencereference  associated to a public ID DEPRECATED, use xmlCatalogResolvePublic()
pubID: the public ID string Returns: the resource if found or NULL otherwise. Function: xmlCatalogGetSystem
const libxml-xmlstring.html#xmlCharxmlChar  *	xmlCatalogGetSystem	(const libxml-xmlstring.html#xmlCharxmlChar  * sysID)Try to lookup the catalog libxml-SAX.html#referencereference  associated to a system ID DEPRECATED, use xmlCatalogResolveSystem()
sysID: the system ID string Returns: the resource if found or NULL otherwise. Function: xmlCatalogIsEmpty
int	xmlCatalogIsEmpty		( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal)Check is a catalog is empty
catal: should this create an SGML catalog Returns: 1 if the catalog is empty, 0 if not, amd -1 in case of error. Function: xmlCatalogLocalResolve
libxml-xmlstring.html#xmlCharxmlChar  *	xmlCatalogLocalResolve	(void * catalogs, 					 const libxml-xmlstring.html#xmlCharxmlChar  * pubID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * sysID)Do a complete resolution lookup of an External Identifier using a document's private catalog list
catalogs: a document's list of catalogs pubID: the public ID string sysID: the system ID string Returns: the URI of the resource or NULL if not found, it must be freed by the caller. Function: xmlCatalogLocalResolveURI
libxml-xmlstring.html#xmlCharxmlChar  *	xmlCatalogLocalResolveURI	(void * catalogs, 						 const libxml-xmlstring.html#xmlCharxmlChar  * URI)Do a complete resolution lookup of an URI using a document's private catalog list
catalogs: a document's list of catalogs URI: the URI Returns: the URI of the resource or NULL if not found, it must be freed by the caller. Function: xmlCatalogRemove
int	xmlCatalogRemove		(const libxml-xmlstring.html#xmlCharxmlChar  * value)Remove an entry from the catalog
value: the value to remove Returns: the number of entries removed if successful, -1 otherwise Function: xmlCatalogResolve
libxml-xmlstring.html#xmlCharxmlChar  *	xmlCatalogResolve	(const libxml-xmlstring.html#xmlCharxmlChar  * pubID, 					 const libxml-xmlstring.html#xmlCharxmlChar  * sysID)Do a complete resolution lookup of an External Identifier
pubID: the public ID string sysID: the system ID string Returns: the URI of the resource or NULL if not found, it must be freed by the caller. Function: xmlCatalogResolvePublic
libxml-xmlstring.html#xmlCharxmlChar  *	xmlCatalogResolvePublic	(const libxml-xmlstring.html#xmlCharxmlChar  * pubID)Try to lookup the catalog libxml-SAX.html#referencereference  associated to a public ID
pubID: the public ID string Returns: the resource if found or NULL otherwise, the value returned must be freed by the caller. Function: xmlCatalogResolveSystem
libxml-xmlstring.html#xmlCharxmlChar  *	xmlCatalogResolveSystem	(const libxml-xmlstring.html#xmlCharxmlChar  * sysID)Try to lookup the catalog resource for a system ID
sysID: the system ID string Returns: the resource if found or NULL otherwise, the value returned must be freed by the caller. Function: xmlCatalogResolveURI
libxml-xmlstring.html#xmlCharxmlChar  *	xmlCatalogResolveURI	(const libxml-xmlstring.html#xmlCharxmlChar  * URI)Do a complete resolution lookup of an URI
URI: the URI Returns: the URI of the resource or NULL if not found, it must be freed by the caller. Function: xmlCatalogSetDebug
int	xmlCatalogSetDebug		(int level)Used to set the debug level for catalog operation, 0 disable debugging, 1 enable it
level: the debug level of catalogs required Returns: the previous value of the catalog debugging level Function: xmlCatalogSetDefaultPrefer
libxml-catalog.html#xmlCatalogPreferxmlCatalogPrefer 	xmlCatalogSetDefaultPrefer	( libxml-catalog.html#xmlCatalogPreferxmlCatalogPrefer  prefer)Allows to set the preference between public and system for deletion in XML Catalog resolution. C.f. section 4.1.1 of the spec Values accepted are libxml-catalog.html#XML_CATA_PREFER_PUBLICXML_CATA_PREFER_PUBLIC  or libxml-catalog.html#XML_CATA_PREFER_SYSTEMXML_CATA_PREFER_SYSTEM 
prefer: the default preference for delegation Returns: the previous value of the default preference for delegation Function: xmlCatalogSetDefaults
void	xmlCatalogSetDefaults		( libxml-catalog.html#xmlCatalogAllowxmlCatalogAllow  allow)Used to set the user preference w.r.t. to what catalogs should be accepted
allow: what catalogs should be accepted Function: xmlConvertSGMLCatalog
int	xmlConvertSGMLCatalog		( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal)Convert all the SGML catalog entries as XML ones
catal: the catalog Returns: the number of entries converted if successful, -1 otherwise Function: xmlFreeCatalog
void	xmlFreeCatalog			( libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  catal)Free the memory allocated to a Catalog
catal: a Catalog Function: xmlInitializeCatalog
void	xmlInitializeCatalog		(void)Do the catalog initialization. this function is not thread safe, catalog initialization should preferably be done once at startup
Function: xmlLoadACatalog
libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr 	xmlLoadACatalog		(const char * filename)Load the catalog and build the associated data structures. This can be either an XML Catalog or an SGML Catalog It will recurse in SGML CATALOG entries. On the other hand XML Catalogs are not handled recursively.
filename: a file path Returns: the catalog parsed or NULL in case of error Function: xmlLoadCatalog
int	xmlLoadCatalog			(const char * filename)Load the catalog and makes its definitions effective for the default external entity loader. It will recurse in SGML CATALOG entries. this function is not thread safe, catalog initialization should preferably be done once at startup
filename: a file path Returns: 0 in case of success -1 in case of error Function: xmlLoadCatalogs
void	xmlLoadCatalogs			(const char * pathss)Load the catalogs and makes their definitions effective for the default external entity loader. this function is not thread safe, catalog initialization should preferably be done once at startup
pathss: a list of directories separated by a colon or a space. Function: xmlLoadSGMLSuperCatalog
libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr 	xmlLoadSGMLSuperCatalog	(const char * filename)Load an SGML super catalog. It won't expand CATALOG or DELEGATE references. This is only needed for manipulating SGML Super Catalogs like adding and removing CATALOG or DELEGATE entries.
filename: a file path Returns: the catalog parsed or NULL in case of error Function: xmlNewCatalog
libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr 	xmlNewCatalog		(int sgml)create a new Catalog.
sgml: should this create an SGML catalog Returns: the libxml-catalog.html#xmlCatalogPtrxmlCatalogPtr  or NULL in case of error Function: xmlParseCatalogFile
libxml-tree.html#xmlDocPtrxmlDocPtr 	xmlParseCatalogFile	(const char * filename)parse an XML file and build a tree. It's like xmlParseFile() except it bypass all catalog lookups.
filename: the filename Returns: the resulting document tree or NULL in case of error ../bugs.htmlDaniel Veillard 
