libxml2/doc/html/libxml-catalog.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>catalog</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
   2         .synopsis, .classsynopsis {
   3             background: #eeeeee;
   4             border: solid 1px #aaaaaa;
   5             padding: 0.5em;
   6         }
   7         .programlisting {
   8             background: #eeeeff;
   9             border: solid 1px #aaaaff;
  10             padding: 0.5em;
  11         }
  12         .variablelist {
  13             padding: 4px;
  14             margin-left: 3em;
  15         }
  16         .navigation {
  17             background: #ffeeee;
  18             border: solid 1px #ffaaaa;
  19             margin-top: 0.5em;
  20             margin-bottom: 0.5em;
  21         }
  22         .navigation a {
  23             color: #770000;
  24         }
  25         .navigation a:visited {
  26             color: #550000;
  27         }
  28         .navigation .title {
  29             font-size: 200%;
  30         }
  31       </style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual"><link rel="up" href="libxml-lib.html" title="Libxml Library Reference"><link rel="previous" href="libxml-xmlIO.html" title="xmlIO"><link rel="next" href="libxml-c14n.html" title="c14n"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-xmlIO.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="libxml-lib.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">Gnome XML Library Reference Manual</th><td><a accesskey="n" href="libxml-c14n.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="libxml-catalog"></a><div class="titlepage"></div><div class="refnamediv"><h2>catalog</h2><p>catalog &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  32
  33
  34
  35 #define     <a href="libxml-catalog.html#XML-CATALOGS-NAMESPACE-CAPS">XML_CATALOGS_NAMESPACE</a>
  36 #define     <a href="libxml-catalog.html#XML-CATALOG-PI-CAPS">XML_CATALOG_PI</a>
  37 enum        <a href="libxml-catalog.html#xmlCatalogPrefer">xmlCatalogPrefer</a>;
  38 enum        <a href="libxml-catalog.html#xmlCatalogAllow">xmlCatalogAllow</a>;
  39 struct      <a href="libxml-catalog.html#xmlCatalog">xmlCatalog</a>;
  40 typedef     <a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a>;
  41 <a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> <a href="libxml-catalog.html#xmlNewCatalog">xmlNewCatalog</a>                 (int sgml);
  42 <a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> <a href="libxml-catalog.html#xmlLoadACatalog">xmlLoadACatalog</a>               (const char *filename);
  43 <a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> <a href="libxml-catalog.html#xmlLoadSGMLSuperCatalog">xmlLoadSGMLSuperCatalog</a>       (const char *filename);
  44 int         <a href="libxml-catalog.html#xmlConvertSGMLCatalog">xmlConvertSGMLCatalog</a>           (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal);
  45 int         <a href="libxml-catalog.html#xmlACatalogAdd">xmlACatalogAdd</a>                  (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
  46                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *type,
  47                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *orig,
  48                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *replace);
  49 int         <a href="libxml-catalog.html#xmlACatalogRemove">xmlACatalogRemove</a>               (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
  50                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);
  51 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlACatalogResolve">xmlACatalogResolve</a>              (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
  52                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID,
  53                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);
  54 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlACatalogResolveSystem">xmlACatalogResolveSystem</a>        (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
  55                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);
  56 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlACatalogResolvePublic">xmlACatalogResolvePublic</a>        (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
  57                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID);
  58 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlACatalogResolveURI">xmlACatalogResolveURI</a>           (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
  59                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URI);
  60 void        <a href="libxml-catalog.html#xmlACatalogDump">xmlACatalogDump</a>                 (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
  61                                              <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *out);
  62 void        <a href="libxml-catalog.html#xmlFreeCatalog">xmlFreeCatalog</a>                  (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal);
  63 int         <a href="libxml-catalog.html#xmlCatalogIsEmpty">xmlCatalogIsEmpty</a>               (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal);
  64 void        <a href="libxml-catalog.html#xmlInitializeCatalog">xmlInitializeCatalog</a>            (void);
  65 int         <a href="libxml-catalog.html#xmlLoadCatalog">xmlLoadCatalog</a>                  (const char *filename);
  66 void        <a href="libxml-catalog.html#xmlLoadCatalogs">xmlLoadCatalogs</a>                 (const char *paths);
  67 void        <a href="libxml-catalog.html#xmlCatalogCleanup">xmlCatalogCleanup</a>               (void);
  68 void        <a href="libxml-catalog.html#xmlCatalogDump">xmlCatalogDump</a>                  (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *out);
  69 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlCatalogResolve">xmlCatalogResolve</a>               (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID,
  70                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);
  71 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlCatalogResolveSystem">xmlCatalogResolveSystem</a>         (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);
  72 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlCatalogResolvePublic">xmlCatalogResolvePublic</a>         (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID);
  73 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlCatalogResolveURI">xmlCatalogResolveURI</a>            (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URI);
  74 int         <a href="libxml-catalog.html#xmlCatalogAdd">xmlCatalogAdd</a>                   (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *type,
  75                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *orig,
  76                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *replace);
  77 int         <a href="libxml-catalog.html#xmlCatalogRemove">xmlCatalogRemove</a>                (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);
  78 <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a>   <a href="libxml-catalog.html#xmlParseCatalogFile">xmlParseCatalogFile</a>             (const char *filename);
  79 int         <a href="libxml-catalog.html#xmlCatalogConvert">xmlCatalogConvert</a>               (void);
  80 void        <a href="libxml-catalog.html#xmlCatalogFreeLocal">xmlCatalogFreeLocal</a>             (void *catalogs);
  81 void*       <a href="libxml-catalog.html#xmlCatalogAddLocal">xmlCatalogAddLocal</a>              (void *catalogs,
  82                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URL);
  83 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlCatalogLocalResolve">xmlCatalogLocalResolve</a>          (void *catalogs,
  84                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID,
  85                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);
  86 <a href="libxml-tree.html#xmlChar">xmlChar</a>*    <a href="libxml-catalog.html#xmlCatalogLocalResolveURI">xmlCatalogLocalResolveURI</a>       (void *catalogs,
  87                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URI);
  88 int         <a href="libxml-catalog.html#xmlCatalogSetDebug">xmlCatalogSetDebug</a>              (int level);
  89 <a href="libxml-catalog.html#xmlCatalogPrefer">xmlCatalogPrefer</a> <a href="libxml-catalog.html#xmlCatalogSetDefaultPrefer">xmlCatalogSetDefaultPrefer</a> (<a href="libxml-catalog.html#xmlCatalogPrefer">xmlCatalogPrefer</a> prefer);
  90 void        <a href="libxml-catalog.html#xmlCatalogSetDefaults">xmlCatalogSetDefaults</a>           (<a href="libxml-catalog.html#xmlCatalogAllow">xmlCatalogAllow</a> allow);
  91 <a href="libxml-catalog.html#xmlCatalogAllow">xmlCatalogAllow</a> <a href="libxml-catalog.html#xmlCatalogGetDefaults">xmlCatalogGetDefaults</a>       (void);
  92 const <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-catalog.html#xmlCatalogGetSystem">xmlCatalogGetSystem</a>          (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);
  93 const <a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-catalog.html#xmlCatalogGetPublic">xmlCatalogGetPublic</a>          (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID);
  94 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  95
  96 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="XML-CATALOGS-NAMESPACE-CAPS"></a>XML_CATALOGS_NAMESPACE</h3><pre class="programlisting">#define     XML_CATALOGS_NAMESPACE</pre><p>
  97 The namespace for the XML Catalogs elements.</p><p>
  98
  99 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="XML-CATALOG-PI-CAPS"></a>XML_CATALOG_PI</h3><pre class="programlisting">#define     XML_CATALOG_PI</pre><p>
 100 The specific XML Catalog Processing Instuction name.</p><p>
 101
 102 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogPrefer"></a>enum xmlCatalogPrefer</h3><pre class="programlisting">typedef enum {
 103     XML_CATA_PREFER_NONE = 0,
 104     XML_CATA_PREFER_PUBLIC = 1,
 105     XML_CATA_PREFER_SYSTEM
 106 } xmlCatalogPrefer;
 107 </pre><p>
 108
 109 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogAllow"></a>enum xmlCatalogAllow</h3><pre class="programlisting">typedef enum {
 110     XML_CATA_ALLOW_NONE = 0,
 111     XML_CATA_ALLOW_GLOBAL = 1,
 112     XML_CATA_ALLOW_DOCUMENT = 2,
 113     XML_CATA_ALLOW_ALL = 3
 114 } xmlCatalogAllow;
 115 </pre><p>
 116
 117 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalog"></a>struct xmlCatalog</h3><pre class="programlisting">struct xmlCatalog;</pre><p>
 118
 119 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogPtr"></a>xmlCatalogPtr</h3><pre class="programlisting">typedef xmlCatalog *xmlCatalogPtr;
 120 </pre><p>
 121
 122 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewCatalog"></a>xmlNewCatalog ()</h3><pre class="programlisting"><a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> xmlNewCatalog                 (int sgml);</pre><p>
 123 create a new Catalog.</p><p>
 124
 125 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>sgml</tt></i> :</span></td><td>  should this create an SGML catalog
 126 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlCatalogPtr or NULL in case of error
 127 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLoadACatalog"></a>xmlLoadACatalog ()</h3><pre class="programlisting"><a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> xmlLoadACatalog               (const char *filename);</pre><p>
 128 Load the catalog and build the associated data structures.
 129 This can be either an XML Catalog or an SGML Catalog
 130 It will recurse in SGML CATALOG entries. On the other hand XML
 131 Catalogs are not handled recursively.</p><p>
 132
 133 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>  a file path
 134 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the catalog parsed or NULL in case of error
 135 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLoadSGMLSuperCatalog"></a>xmlLoadSGMLSuperCatalog ()</h3><pre class="programlisting"><a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> xmlLoadSGMLSuperCatalog       (const char *filename);</pre><p>
 136 Load an SGML super catalog. It won't expand CATALOG or DELEGATE
 137 references. This is only needed for manipulating SGML Super Catalogs
 138 like adding and removing CATALOG or DELEGATE entries.</p><p>
 139
 140 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>  a file path
 141 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the catalog parsed or NULL in case of error
 142 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlConvertSGMLCatalog"></a>xmlConvertSGMLCatalog ()</h3><pre class="programlisting">int         xmlConvertSGMLCatalog           (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal);</pre><p>
 143 Convert all the SGML catalog entries as XML ones</p><p>
 144
 145 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td> the catalog
 146 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of entries converted if successful, -1 otherwise
 147 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlACatalogAdd"></a>xmlACatalogAdd ()</h3><pre class="programlisting">int         xmlACatalogAdd                  (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
 148                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *type,
 149                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *orig,
 150                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *replace);</pre><p>
 151 Add an entry in the catalog, it may overwrite existing but
 152 different entries.</p><p>
 153
 154 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  a Catalog
 155 </td></tr><tr><td><span class="term"><i><tt>type</tt></i> :</span></td><td>  the type of record to add to the catalog
 156 </td></tr><tr><td><span class="term"><i><tt>orig</tt></i> :</span></td><td>  the system, public or prefix to match
 157 </td></tr><tr><td><span class="term"><i><tt>replace</tt></i> :</span></td><td>  the replacement value for the match
 158 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if successful, -1 otherwise
 159 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlACatalogRemove"></a>xmlACatalogRemove ()</h3><pre class="programlisting">int         xmlACatalogRemove               (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
 160                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);</pre><p>
 161 Remove an entry from the catalog</p><p>
 162
 163 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  a Catalog
 164 </td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td>  the value to remove
 165 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of entries removed if successful, -1 otherwise
 166 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlACatalogResolve"></a>xmlACatalogResolve ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlACatalogResolve              (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
 167                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID,
 168                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);</pre><p>
 169 Do a complete resolution lookup of an External Identifier</p><p>
 170
 171 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  a Catalog
 172 </td></tr><tr><td><span class="term"><i><tt>pubID</tt></i> :</span></td><td>  the public ID string
 173 </td></tr><tr><td><span class="term"><i><tt>sysID</tt></i> :</span></td><td>  the system ID string
 174 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the URI of the resource or NULL if not found, it must be freed
 175      by the caller.
 176 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlACatalogResolveSystem"></a>xmlACatalogResolveSystem ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlACatalogResolveSystem        (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
 177                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);</pre><p>
 178 Try to lookup the catalog resource for a system ID</p><p>
 179
 180 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  a Catalog
 181 </td></tr><tr><td><span class="term"><i><tt>sysID</tt></i> :</span></td><td>  the public ID string
 182 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the system ID if found or NULL otherwise, the value returned
 183      must be freed by the caller.
 184 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlACatalogResolvePublic"></a>xmlACatalogResolvePublic ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlACatalogResolvePublic        (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
 185                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID);</pre><p>
 186 Try to lookup the system ID associated to a public ID in that catalog</p><p>
 187
 188 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  a Catalog
 189 </td></tr><tr><td><span class="term"><i><tt>pubID</tt></i> :</span></td><td>  the public ID string
 190 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the system ID if found or NULL otherwise, the value returned
 191      must be freed by the caller.
 192 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlACatalogResolveURI"></a>xmlACatalogResolveURI ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlACatalogResolveURI           (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
 193                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URI);</pre><p>
 194 Do a complete resolution lookup of an URI</p><p>
 195
 196 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  a Catalog
 197 </td></tr><tr><td><span class="term"><i><tt>URI</tt></i> :</span></td><td>  the URI
 198 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the URI of the resource or NULL if not found, it must be freed
 199      by the caller.
 200 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlACatalogDump"></a>xmlACatalogDump ()</h3><pre class="programlisting">void        xmlACatalogDump                 (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal,
 201                                              <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *out);</pre><p>
 202 Free up all the memory associated with catalogs</p><p>
 203
 204 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  a Catalog
 205 </td></tr><tr><td><span class="term"><i><tt>out</tt></i> :</span></td><td>  the file.
 206 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFreeCatalog"></a>xmlFreeCatalog ()</h3><pre class="programlisting">void        xmlFreeCatalog                  (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal);</pre><p>
 207 Free the memory allocated to a Catalog</p><p>
 208
 209 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  a Catalog entry
 210 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogIsEmpty"></a>xmlCatalogIsEmpty ()</h3><pre class="programlisting">int         xmlCatalogIsEmpty               (<a href="libxml-catalog.html#xmlCatalogPtr">xmlCatalogPtr</a> catal);</pre><p>
 211 Check is a catalog is empty</p><p>
 212
 213 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catal</tt></i> :</span></td><td>  should this create an SGML catalog
 214 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if the catalog is empty, 0 if not, amd -1 in case of error.
 215 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlInitializeCatalog"></a>xmlInitializeCatalog ()</h3><pre class="programlisting">void        xmlInitializeCatalog            (void);</pre><p>
 216 Do the catalog initialization.
 217 this function is not thread safe, catalog initialization should
 218 preferably be done once at startup</p><p>
 219
 220 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLoadCatalog"></a>xmlLoadCatalog ()</h3><pre class="programlisting">int         xmlLoadCatalog                  (const char *filename);</pre><p>
 221 Load the catalog and makes its definitions effective for the default
 222 external entity loader. It will recurse in SGML CATALOG entries.
 223 this function is not thread safe, catalog initialization should
 224 preferably be done once at startup</p><p>
 225
 226 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>  a file path
 227 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of success -1 in case of error
 228 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLoadCatalogs"></a>xmlLoadCatalogs ()</h3><pre class="programlisting">void        xmlLoadCatalogs                 (const char *paths);</pre><p>
 229 Load the catalogs and makes their definitions effective for the default
 230 external entity loader.
 231 this function is not thread safe, catalog initialization should
 232 preferably be done once at startup</p><p>
 233
 234 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>paths</tt></i> :</span></td><td>
 235
 236
 237 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogCleanup"></a>xmlCatalogCleanup ()</h3><pre class="programlisting">void        xmlCatalogCleanup               (void);</pre><p>
 238 Free up all the memory associated with catalogs</p><p>
 239
 240 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogDump"></a>xmlCatalogDump ()</h3><pre class="programlisting">void        xmlCatalogDump                  (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *out);</pre><p>
 241 Free up all the memory associated with catalogs</p><p>
 242
 243 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>out</tt></i> :</span></td><td>  the file.
 244 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogResolve"></a>xmlCatalogResolve ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlCatalogResolve               (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID,
 245                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);</pre><p>
 246 Do a complete resolution lookup of an External Identifier</p><p>
 247
 248 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>pubID</tt></i> :</span></td><td>  the public ID string
 249 </td></tr><tr><td><span class="term"><i><tt>sysID</tt></i> :</span></td><td>  the system ID string
 250 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the URI of the resource or NULL if not found, it must be freed
 251      by the caller.
 252 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogResolveSystem"></a>xmlCatalogResolveSystem ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlCatalogResolveSystem         (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);</pre><p>
 253 Try to lookup the catalog resource for a system ID</p><p>
 254
 255 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>sysID</tt></i> :</span></td><td>  the public ID string
 256 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the system ID if found or NULL otherwise, the value returned
 257      must be freed by the caller.
 258 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogResolvePublic"></a>xmlCatalogResolvePublic ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlCatalogResolvePublic         (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID);</pre><p>
 259 Try to lookup the system ID associated to a public ID</p><p>
 260
 261 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>pubID</tt></i> :</span></td><td>  the public ID string
 262 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the system ID if found or NULL otherwise, the value returned
 263      must be freed by the caller.
 264 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogResolveURI"></a>xmlCatalogResolveURI ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlCatalogResolveURI            (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URI);</pre><p>
 265 Do a complete resolution lookup of an URI</p><p>
 266
 267 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>URI</tt></i> :</span></td><td>  the URI
 268 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the URI of the resource or NULL if not found, it must be freed
 269      by the caller.
 270 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogAdd"></a>xmlCatalogAdd ()</h3><pre class="programlisting">int         xmlCatalogAdd                   (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *type,
 271                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *orig,
 272                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *replace);</pre><p>
 273 Add an entry in the catalog, it may overwrite existing but
 274 different entries.
 275 If called before any other catalog routine, allows to override the
 276 default shared catalog put in place by <a href="libxml-catalog.html#xmlInitializeCatalog">xmlInitializeCatalog</a>();</p><p>
 277
 278 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>type</tt></i> :</span></td><td>  the type of record to add to the catalog
 279 </td></tr><tr><td><span class="term"><i><tt>orig</tt></i> :</span></td><td>  the system, public or prefix to match
 280 </td></tr><tr><td><span class="term"><i><tt>replace</tt></i> :</span></td><td>  the replacement value for the match
 281 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if successful, -1 otherwise
 282 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogRemove"></a>xmlCatalogRemove ()</h3><pre class="programlisting">int         xmlCatalogRemove                (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);</pre><p>
 283 Remove an entry from the catalog</p><p>
 284
 285 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td>  the value to remove
 286 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of entries removed if successful, -1 otherwise
 287 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseCatalogFile"></a>xmlParseCatalogFile ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a>   xmlParseCatalogFile             (const char *filename);</pre><p>
 288 parse an XML file and build a tree. It's like <a href="libxml-parser.html#xmlParseFile">xmlParseFile</a>()
 289 except it bypass all catalog lookups.</p><p>
 290
 291 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>  the filename
 292 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the resulting document tree or NULL in case of error
 293 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogConvert"></a>xmlCatalogConvert ()</h3><pre class="programlisting">int         xmlCatalogConvert               (void);</pre><p>
 294 Convert all the SGML catalog entries as XML ones</p><p>
 295
 296 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of entries converted if successful, -1 otherwise
 297 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogFreeLocal"></a>xmlCatalogFreeLocal ()</h3><pre class="programlisting">void        xmlCatalogFreeLocal             (void *catalogs);</pre><p>
 298 Free up the memory associated to the catalog list</p><p>
 299
 300 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catalogs</tt></i> :</span></td><td>  a document's list of catalogs
 301 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogAddLocal"></a>xmlCatalogAddLocal ()</h3><pre class="programlisting">void*       xmlCatalogAddLocal              (void *catalogs,
 302                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URL);</pre><p>
 303 Add the new entry to the catalog list</p><p>
 304
 305 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catalogs</tt></i> :</span></td><td>  a document's list of catalogs
 306 </td></tr><tr><td><span class="term"><i><tt>URL</tt></i> :</span></td><td>  the URL to a new local catalog
 307 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogLocalResolve"></a>xmlCatalogLocalResolve ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlCatalogLocalResolve          (void *catalogs,
 308                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID,
 309                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);</pre><p>
 310 Do a complete resolution lookup of an External Identifier using a
 311 document's private catalog list</p><p>
 312
 313 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catalogs</tt></i> :</span></td><td>  a document's list of catalogs
 314 </td></tr><tr><td><span class="term"><i><tt>pubID</tt></i> :</span></td><td>  the public ID string
 315 </td></tr><tr><td><span class="term"><i><tt>sysID</tt></i> :</span></td><td>  the system ID string
 316 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the URI of the resource or NULL if not found, it must be freed
 317      by the caller.
 318 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogLocalResolveURI"></a>xmlCatalogLocalResolveURI ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>*    xmlCatalogLocalResolveURI       (void *catalogs,
 319                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URI);</pre><p>
 320 Do a complete resolution lookup of an URI using a
 321 document's private catalog list</p><p>
 322
 323 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>catalogs</tt></i> :</span></td><td>  a document's list of catalogs
 324 </td></tr><tr><td><span class="term"><i><tt>URI</tt></i> :</span></td><td>  the URI
 325 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the URI of the resource or NULL if not found, it must be freed
 326      by the caller.
 327 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogSetDebug"></a>xmlCatalogSetDebug ()</h3><pre class="programlisting">int         xmlCatalogSetDebug              (int level);</pre><p>
 328 Used to set the debug level for catalog operation, 0 disable
 329 debugging, 1 enable it</p><p>
 330
 331 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>level</tt></i> :</span></td><td>  the debug level of catalogs required
 332 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the previous value of the catalog debugging level
 333 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogSetDefaultPrefer"></a>xmlCatalogSetDefaultPrefer ()</h3><pre class="programlisting"><a href="libxml-catalog.html#xmlCatalogPrefer">xmlCatalogPrefer</a> xmlCatalogSetDefaultPrefer (<a href="libxml-catalog.html#xmlCatalogPrefer">xmlCatalogPrefer</a> prefer);</pre><p>
 334 Allows to set the preference between public and system for deletion
 335 in XML Catalog resolution. C.f. section 4.1.1 of the spec
 336 Values accepted are XML_CATA_PREFER_PUBLIC or XML_CATA_PREFER_SYSTEM</p><p>
 337
 338 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>prefer</tt></i> :</span></td><td>  the default preference for delegation
 339 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the previous value of the default preference for delegation
 340 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogSetDefaults"></a>xmlCatalogSetDefaults ()</h3><pre class="programlisting">void        xmlCatalogSetDefaults           (<a href="libxml-catalog.html#xmlCatalogAllow">xmlCatalogAllow</a> allow);</pre><p>
 341 Used to set the user preference w.r.t. to what catalogs should
 342 be accepted</p><p>
 343
 344 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>allow</tt></i> :</span></td><td>  what catalogs should be accepted
 345 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogGetDefaults"></a>xmlCatalogGetDefaults ()</h3><pre class="programlisting"><a href="libxml-catalog.html#xmlCatalogAllow">xmlCatalogAllow</a> xmlCatalogGetDefaults       (void);</pre><p>
 346 Used to get the user preference w.r.t. to what catalogs should
 347 be accepted</p><p>
 348
 349 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the current xmlCatalogAllow value
 350 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogGetSystem"></a>xmlCatalogGetSystem ()</h3><pre class="programlisting">const <a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlCatalogGetSystem          (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *sysID);</pre><p>
 351 Try to lookup the system ID associated to a public ID
 352 DEPRECATED, use <a href="libxml-catalog.html#xmlCatalogResolveSystem">xmlCatalogResolveSystem</a>()</p><p>
 353
 354 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>sysID</tt></i> :</span></td><td>  the system ID string
 355 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the system ID if found or NULL otherwise.
 356 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCatalogGetPublic"></a>xmlCatalogGetPublic ()</h3><pre class="programlisting">const <a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlCatalogGetPublic          (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *pubID);</pre><p>
 357 Try to lookup the system ID associated to a public ID
 358 DEPRECATED, use <a href="libxml-catalog.html#xmlCatalogResolvePublic">xmlCatalogResolvePublic</a>()</p><p>
 359
 360 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>pubID</tt></i> :</span></td><td>  the public ID string
 361 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the system ID if found or NULL otherwise.
 362 </td></tr></tbody></table></div></div></div></div><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-xmlIO.html"><b>&lt;&lt; xmlIO</b></a></td><td align="right"><a accesskey="n" href="libxml-c14n.html"><b>c14n &gt;&gt;</b></a></td></tr></table></body></html>