docs/api/xmlsec-parser.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   4 <title>parser</title>
   5 <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
   6 <link rel="HOME" title="XML Security Library Reference Manual" href="index.html">
   7 <link rel="UP" title="XML Security Core Library API Reference." href="xmlsec-ref.html">
   8 <link rel="PREVIOUS" title="nodeset" href="xmlsec-nodeset.html">
   9 <link rel="NEXT" title="templates" href="xmlsec-templates.html">
  10 <style type="text/css">.synopsis, .classsynopsis {
  11     background: #eeeeee;
  12     border: solid 1px #aaaaaa;
  13     padding: 0.5em;
  14 }
  15 .programlisting {
  16     background: #eeeeff;
  17     border: solid 1px #aaaaff;
  18     padding: 0.5em;
  19 }
  20 .variablelist {
  21     padding: 4px;
  22     margin-left: 3em;
  23 }
  24 .navigation {
  25     background: #ffeeee;
  26     border: solid 1px #ffaaaa;
  27     margin-top: 0.5em;
  28     margin-bottom: 0.5em;
  29 }
  30 .navigation a {
  31     color: #770000;
  32 }
  33 .navigation a:visited {
  34     color: #550000;
  35 }
  36 .navigation .title {
  37     font-size: 200%;
  38 }</style>
  39 </head>
  40 <body><table witdh="100%" valign="top"><tr valign="top">
  41 <td valign="top" align="left" width="210">
  42 <img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p>
  43 <ul>
  44 <li><a href="../index.html">Home</a></li>
  45 <li><a href="../download.html">Download</a></li>
  46 <li><a href="../news.html">News</a></li>
  47 <li><a href="../documentation.html">Documentation</a></li>
  48 <ul>
  49 <li><a href="../faq.html">FAQ</a></li>
  50 <li><a href="../api/xmlsec-notes.html">Tutorial</a></li>
  51 <li><a href="../api/xmlsec-reference.html">API reference</a></li>
  52 <li><a href="../api/xmlsec-examples.html">Examples</a></li>
  53 </ul>
  54 <li><a href="../xmldsig.html">XML Digital Signature</a></li>
  55 <ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul>
  56 <li><a href="../xmlenc.html">XML Encryption</a></li>
  57 <li><a href="../c14n.html">XML Canonicalization</a></li>
  58 <li><a href="../bugs.html">Reporting Bugs</a></li>
  59 <li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li>
  60 <li><a href="../related.html">Related</a></li>
  61 <li><a href="../authors.html">Authors</a></li>
  62 </ul>
  63 <table width="100%">
  64 <tr>
  65 <td width="15"></td>
  66 <td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td>
  67 </tr>
  68 <tr>
  69 <td width="15"></td>
  70 <td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td>
  71 </tr>
  72 <tr>
  73 <td width="15"></td>
  74 <td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td>
  75 </tr>
  76 <!--Links - start--><!--Links - end-->
  77 </table>
  78 </td>
  79 <td valign="top"><table width="100%" valign="top"><tr><td valign="top" align="left" id="xmlsecContent">
  80 <table width="100%" class="navigation" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
  81 <td><a accesskey="p" href="xmlsec-nodeset.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  82 <td><a accesskey="u" href="xmlsec-ref.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  83 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  84 <th width="100%" align="center">XML Security Library Reference Manual</th>
  85 <td><a accesskey="n" href="xmlsec-templates.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  86 </tr></table>
  87 <h1>
  88 <a name="XMLSEC-PARSER"></a>parser</h1>
  89 <div class="REFNAMEDIV">
  90 <a name="AEN12089"></a><h2>Name</h2>parser -- Parser transform implementation.</div>
  91 <div class="REFSYNOPSISDIV">
  92 <a name="XMLSEC-PARSER.SYNOPSIS"></a><h2>Synopsis</h2>
  93 <pre class="SYNOPSIS"><font>xmlDocPtr</font>           <a href="xmlsec-parser.html#XMLSECPARSEFILE">xmlSecParseFile</a>                     (const <font>char</font> *filename);
  94 <font>xmlDocPtr</font>           <a href="xmlsec-parser.html#XMLSECPARSEMEMORY">xmlSecParseMemory</a>                   (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buffer,
  95                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> size,
  96                                                          <font>int</font> recovery);
  97 <font>xmlDocPtr</font>           <a href="xmlsec-parser.html#XMLSECPARSEMEMORYEXT">xmlSecParseMemoryExt</a>                (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *prefix,
  98                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> prefixSize,
  99                                                          const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buffer,
 100                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> bufferSize,
 101                                                          const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *postfix,
 102                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> postfixSize);
 103 #define             <a href="xmlsec-parser.html#XMLSECTRANSFORMXMLPARSERID">xmlSecTransformXmlParserId</a>
 104 <font>xmlSecTransformId</font>   <a href="xmlsec-parser.html#XMLSECTRANSFORMXMLPARSERGETKLASS">xmlSecTransformXmlParserGetKlass</a>    (void);</pre>
 105 </div>
 106 <div class="REFSECT1">
 107 <a name="XMLSEC-PARSER.DESCRIPTION"></a><h2>Description</h2>
 108 <p>Parser transform implementation.</p>
 109 </div>
 110 <div class="REFSECT1">
 111 <a name="XMLSEC-PARSER.DETAILS"></a><h2>Details</h2>
 112 <div class="REFSECT2">
 113 <a name="XMLSECPARSEFILE"></a><h3>xmlSecParseFile ()</h3>
 114 <pre class="PROGRAMLISTING"><font>xmlDocPtr</font>           xmlSecParseFile                     (const <font>char</font> *filename);</pre>
 115 <p>Loads XML Doc from file <code class="PARAMETER">filename</code>. We need a special version because of
 116 c14n issue. The code is copied from <gtkdoclink href="XMLSAXPARSEFILEWITHDATA"><code class="FUNCTION">xmlSAXParseFileWithData()</code></gtkdoclink> function.</p>
 117 <p></p>
 118 <p></p>
 119 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 120 <tr>
 121 <td align="LEFT" valign="TOP"><a name="AEN12132"><span style="white-space: nowrap"><code class="PARAMETER">filename</code> :</span></a></td>
 122 <td align="LEFT" valign="TOP"><p>               the filename.</p></td>
 123 </tr>
 124 <tr>
 125 <td align="LEFT" valign="TOP"><a name="AEN12137"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 126 <td align="LEFT" valign="TOP"><p> pointer to the loaded XML document or NULL if an error occurs.</p></td>
 127 </tr>
 128 </tbody></table>
 129 </div>
 130 <hr>
 131 <div class="REFSECT2">
 132 <a name="XMLSECPARSEMEMORY"></a><h3>xmlSecParseMemory ()</h3>
 133 <pre class="PROGRAMLISTING"><font>xmlDocPtr</font>           xmlSecParseMemory                   (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buffer,
 134                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> size,
 135                                                          <font>int</font> recovery);</pre>
 136 <p>Loads XML Doc from memory. We need a special version because of
 137 c14n issue. The code is copied from <gtkdoclink href="XMLSAXPARSEMEMORY"><code class="FUNCTION">xmlSAXParseMemory()</code></gtkdoclink> function.</p>
 138 <p></p>
 139 <p></p>
 140 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 141 <tr>
 142 <td align="LEFT" valign="TOP"><a name="AEN12156"><span style="white-space: nowrap"><code class="PARAMETER">buffer</code> :</span></a></td>
 143 <td align="LEFT" valign="TOP"><p>               the input buffer.</p></td>
 144 </tr>
 145 <tr>
 146 <td align="LEFT" valign="TOP"><a name="AEN12161"><span style="white-space: nowrap"><code class="PARAMETER">size</code> :</span></a></td>
 147 <td align="LEFT" valign="TOP"><p>               the input buffer size.</p></td>
 148 </tr>
 149 <tr>
 150 <td align="LEFT" valign="TOP"><a name="AEN12166"><span style="white-space: nowrap"><code class="PARAMETER">recovery</code> :</span></a></td>
 151 <td align="LEFT" valign="TOP"><p>               the flag.</p></td>
 152 </tr>
 153 <tr>
 154 <td align="LEFT" valign="TOP"><a name="AEN12171"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 155 <td align="LEFT" valign="TOP"><p> pointer to the loaded XML document or NULL if an error occurs.</p></td>
 156 </tr>
 157 </tbody></table>
 158 </div>
 159 <hr>
 160 <div class="REFSECT2">
 161 <a name="XMLSECPARSEMEMORYEXT"></a><h3>xmlSecParseMemoryExt ()</h3>
 162 <pre class="PROGRAMLISTING"><font>xmlDocPtr</font>           xmlSecParseMemoryExt                (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *prefix,
 163                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> prefixSize,
 164                                                          const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buffer,
 165                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> bufferSize,
 166                                                          const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *postfix,
 167                                                          <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> postfixSize);</pre>
 168 <p>Loads XML Doc from 3 chunks of memory: <code class="PARAMETER">prefix</code>, <code class="PARAMETER">buffer</code> and <code class="PARAMETER">postfix</code>.</p>
 169 <p></p>
 170 <p></p>
 171 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 172 <tr>
 173 <td align="LEFT" valign="TOP"><a name="AEN12194"><span style="white-space: nowrap"><code class="PARAMETER">prefix</code> :</span></a></td>
 174 <td align="LEFT" valign="TOP"><p>               the first part of the input.</p></td>
 175 </tr>
 176 <tr>
 177 <td align="LEFT" valign="TOP"><a name="AEN12199"><span style="white-space: nowrap"><code class="PARAMETER">prefixSize</code> :</span></a></td>
 178 <td align="LEFT" valign="TOP"><p>       the size of the first part of the input.</p></td>
 179 </tr>
 180 <tr>
 181 <td align="LEFT" valign="TOP"><a name="AEN12204"><span style="white-space: nowrap"><code class="PARAMETER">buffer</code> :</span></a></td>
 182 <td align="LEFT" valign="TOP"><p>               the second part of the input.</p></td>
 183 </tr>
 184 <tr>
 185 <td align="LEFT" valign="TOP"><a name="AEN12209"><span style="white-space: nowrap"><code class="PARAMETER">bufferSize</code> :</span></a></td>
 186 <td align="LEFT" valign="TOP"><p>       the size of the second part of the input.</p></td>
 187 </tr>
 188 <tr>
 189 <td align="LEFT" valign="TOP"><a name="AEN12214"><span style="white-space: nowrap"><code class="PARAMETER">postfix</code> :</span></a></td>
 190 <td align="LEFT" valign="TOP"><p>               the third part of the input.</p></td>
 191 </tr>
 192 <tr>
 193 <td align="LEFT" valign="TOP"><a name="AEN12219"><span style="white-space: nowrap"><code class="PARAMETER">postfixSize</code> :</span></a></td>
 194 <td align="LEFT" valign="TOP"><p>       the size of the third part of the input.</p></td>
 195 </tr>
 196 <tr>
 197 <td align="LEFT" valign="TOP"><a name="AEN12224"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 198 <td align="LEFT" valign="TOP"><p> pointer to the loaded XML document or NULL if an error occurs.</p></td>
 199 </tr>
 200 </tbody></table>
 201 </div>
 202 <hr>
 203 <div class="REFSECT2">
 204 <a name="XMLSECTRANSFORMXMLPARSERID"></a><h3>xmlSecTransformXmlParserId</h3>
 205 <pre class="PROGRAMLISTING">#define             xmlSecTransformXmlParserId</pre>
 206 <p>The XML Parser transform klass.</p>
 207 <p></p>
 208 </div>
 209 <hr>
 210 <div class="REFSECT2">
 211 <a name="XMLSECTRANSFORMXMLPARSERGETKLASS"></a><h3>xmlSecTransformXmlParserGetKlass ()</h3>
 212 <pre class="PROGRAMLISTING"><font>xmlSecTransformId</font>   xmlSecTransformXmlParserGetKlass    (void);</pre>
 213 <p>The XML parser transform.</p>
 214 <p></p>
 215 <p></p>
 216 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
 217 <td align="LEFT" valign="TOP"><a name="AEN12245"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 218 <td align="LEFT" valign="TOP"><p> XML parser transform klass.</p></td>
 219 </tr></tbody></table>
 220 </div>
 221 </div>
 222 <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle">
 223 <td align="left"><a accesskey="p" href="xmlsec-nodeset.html"><b>&lt;&lt;&lt; nodeset</b></a></td>
 224 <td align="right"><a accesskey="n" href="xmlsec-templates.html"><b>templates &gt;&gt;&gt;</b></a></td>
 225 </tr></table>
 226 </td></tr></table></td>
 227 </tr></table></body>
 228 </html>