libxml2/doc/html/libxml-xmlschemastypes.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlschemastypes</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-xmlschemas.html" title="xmlschemas"><link rel="next" href="libxml-schemasInternals.html" title="schemasInternals"></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-xmlschemas.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-schemasInternals.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-xmlschemastypes"></a><div class="titlepage"></div><div class="refnamediv"><h2>xmlschemastypes</h2><p>xmlschemastypes &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  32
  33
  34
  35 void        <a href="libxml-xmlschemastypes.html#xmlSchemaInitTypes">xmlSchemaInitTypes</a>              (void);
  36 void        <a href="libxml-xmlschemastypes.html#xmlSchemaCleanupTypes">xmlSchemaCleanupTypes</a>           (void);
  37 <a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> <a href="libxml-xmlschemastypes.html#xmlSchemaGetPredefinedType">xmlSchemaGetPredefinedType</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,
  38                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ns);
  39 int         <a href="libxml-xmlschemastypes.html#xmlSchemaValidatePredefinedType">xmlSchemaValidatePredefinedType</a> (<a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> type,
  40                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
  41                                              <a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> *val);
  42 int         <a href="libxml-xmlschemastypes.html#xmlSchemaValPredefTypeNode">xmlSchemaValPredefTypeNode</a>      (<a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> type,
  43                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
  44                                              <a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> *val,
  45                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);
  46 int         <a href="libxml-xmlschemastypes.html#xmlSchemaValidateFacet">xmlSchemaValidateFacet</a>          (<a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> base,
  47                                              <a href="libxml-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> facet,
  48                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
  49                                              <a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> val);
  50 void        <a href="libxml-xmlschemastypes.html#xmlSchemaFreeValue">xmlSchemaFreeValue</a>              (<a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> val);
  51 <a href="libxml-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> <a href="libxml-xmlschemastypes.html#xmlSchemaNewFacet">xmlSchemaNewFacet</a>         (void);
  52 int         <a href="libxml-xmlschemastypes.html#xmlSchemaCheckFacet">xmlSchemaCheckFacet</a>             (<a href="libxml-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> facet,
  53                                              <a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> typeDecl,
  54                                              <a href="libxml-xmlschemas.html#xmlSchemaParserCtxtPtr">xmlSchemaParserCtxtPtr</a> ctxt,
  55                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);
  56 void        <a href="libxml-xmlschemastypes.html#xmlSchemaFreeFacet">xmlSchemaFreeFacet</a>              (<a href="libxml-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> facet);
  57 int         <a href="libxml-xmlschemastypes.html#xmlSchemaCompareValues">xmlSchemaCompareValues</a>          (<a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> x,
  58                                              <a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> y);
  59 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  60
  61 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="xmlSchemaInitTypes"></a>xmlSchemaInitTypes ()</h3><pre class="programlisting">void        xmlSchemaInitTypes              (void);</pre><p>
  62
  63 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaCleanupTypes"></a>xmlSchemaCleanupTypes ()</h3><pre class="programlisting">void        xmlSchemaCleanupTypes           (void);</pre><p>
  64 Cleanup the default XML Schemas type library</p><p>
  65
  66 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaGetPredefinedType"></a>xmlSchemaGetPredefinedType ()</h3><pre class="programlisting"><a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> xmlSchemaGetPredefinedType (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,
  67                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ns);</pre><p>
  68 Lookup a type in the default XML Schemas type library</p><p>
  69
  70 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the type name
  71 </td></tr><tr><td><span class="term"><i><tt>ns</tt></i> :</span></td><td>  the URI of the namespace usually "http://www.w3.org/2001/XMLSchema"
  72 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the type if found, NULL otherwise
  73 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaValidatePredefinedType"></a>xmlSchemaValidatePredefinedType ()</h3><pre class="programlisting">int         xmlSchemaValidatePredefinedType (<a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> type,
  74                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
  75                                              <a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> *val);</pre><p>
  76 Check that a value conforms to the lexical space of the predefined type.
  77 if true a value is computed and returned in <i><tt>val</tt></i>.</p><p>
  78
  79 </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 predefined type
  80 </td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> the value to check
  81 </td></tr><tr><td><span class="term"><i><tt>val</tt></i> :</span></td><td>  the return computed value
  82 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if this validates, a positive error code number otherwise
  83         and -1 in case of internal or API error.
  84 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaValPredefTypeNode"></a>xmlSchemaValPredefTypeNode ()</h3><pre class="programlisting">int         xmlSchemaValPredefTypeNode      (<a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> type,
  85                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
  86                                              <a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> *val,
  87                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);</pre><p>
  88 Check that a value conforms to the lexical space of the predefined type.
  89 if true a value is computed and returned in <i><tt>val</tt></i>.</p><p>
  90
  91 </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 predefined type
  92 </td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> the value to check
  93 </td></tr><tr><td><span class="term"><i><tt>val</tt></i> :</span></td><td>  the return computed value
  94 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  the node containing the value
  95 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if this validates, a positive error code number otherwise
  96         and -1 in case of internal or API error.
  97 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaValidateFacet"></a>xmlSchemaValidateFacet ()</h3><pre class="programlisting">int         xmlSchemaValidateFacet          (<a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> base,
  98                                              <a href="libxml-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> facet,
  99                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *value,
 100                                              <a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> val);</pre><p>
 101 Check a value against a facet condition</p><p>
 102
 103 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>base</tt></i> :</span></td><td>  the base type
 104 </td></tr><tr><td><span class="term"><i><tt>facet</tt></i> :</span></td><td>  the facet to check
 105 </td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td>  the lexical repr of the value to validate
 106 </td></tr><tr><td><span class="term"><i><tt>val</tt></i> :</span></td><td>  the precomputed value
 107 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if the element is schemas valid, a positive error code
 108     number otherwise and -1 in case of internal or API error.
 109 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaFreeValue"></a>xmlSchemaFreeValue ()</h3><pre class="programlisting">void        xmlSchemaFreeValue              (<a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> val);</pre><p>
 110 Cleanup the default XML Schemas type library</p><p>
 111
 112 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>val</tt></i> :</span></td><td>
 113
 114
 115 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaNewFacet"></a>xmlSchemaNewFacet ()</h3><pre class="programlisting"><a href="libxml-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> xmlSchemaNewFacet         (void);</pre><p>
 116 Allocate a new Facet structure.</p><p>
 117
 118 </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 newly allocated structure or NULL in case or error
 119 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaCheckFacet"></a>xmlSchemaCheckFacet ()</h3><pre class="programlisting">int         xmlSchemaCheckFacet             (<a href="libxml-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> facet,
 120                                              <a href="libxml-schemasInternals.html#xmlSchemaTypePtr">xmlSchemaTypePtr</a> typeDecl,
 121                                              <a href="libxml-xmlschemas.html#xmlSchemaParserCtxtPtr">xmlSchemaParserCtxtPtr</a> ctxt,
 122                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name);</pre><p>
 123 Checks the default values types, especially for facets</p><p>
 124
 125 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>facet</tt></i> :</span></td><td>  the facet
 126 </td></tr><tr><td><span class="term"><i><tt>typeDecl</tt></i> :</span></td><td>  the schema type definition
 127 </td></tr><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td>  the schema parser context or NULL
 128 </td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> name of the type
 129 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if okay or -1 in cae of error
 130 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaFreeFacet"></a>xmlSchemaFreeFacet ()</h3><pre class="programlisting">void        xmlSchemaFreeFacet              (<a href="libxml-schemasInternals.html#xmlSchemaFacetPtr">xmlSchemaFacetPtr</a> facet);</pre><p>
 131 Deallocate a Schema Facet structure.</p><p>
 132
 133 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>facet</tt></i> :</span></td><td>  a schema facet structure
 134 </td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSchemaCompareValues"></a>xmlSchemaCompareValues ()</h3><pre class="programlisting">int         xmlSchemaCompareValues          (<a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> x,
 135                                              <a href="libxml-schemasInternals.html#xmlSchemaValPtr">xmlSchemaValPtr</a> y);</pre><p>
 136 Compare 2 values</p><p>
 137
 138 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>x</tt></i> :</span></td><td>  a first value
 139 </td></tr><tr><td><span class="term"><i><tt>y</tt></i> :</span></td><td>  a second value
 140 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>-1 if x &lt; y, 0 if x == y, 1 if x &gt; y, 2 if x &lt;&gt; y, and -2 in
 141 case of error
 142 </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-xmlschemas.html"><b>&lt;&lt; xmlschemas</b></a></td><td align="right"><a accesskey="n" href="libxml-schemasInternals.html"><b>schemasInternals &gt;&gt;</b></a></td></tr></table></body></html>