docs/api/xmlsec-io.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   4 <title>io</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="errors" href="xmlsec-errors.html">
   9 <link rel="NEXT" title="keyinfo" href="xmlsec-keyinfo.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-errors.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-keyinfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  86 </tr></table>
  87 <h1>
  88 <a name="XMLSEC-IO"></a>io</h1>
  89 <div class="REFNAMEDIV">
  90 <a name="AEN5268"></a><h2>Name</h2>io -- Input/output support.</div>
  91 <div class="REFSYNOPSISDIV">
  92 <a name="XMLSEC-IO.SYNOPSIS"></a><h2>Synopsis</h2>
  93 <pre class="SYNOPSIS"><font>int</font>                 <a href="xmlsec-io.html#XMLSECIOINIT">xmlSecIOInit</a>                        (void);
  94 <font>void</font>                <a href="xmlsec-io.html#XMLSECIOSHUTDOWN">xmlSecIOShutdown</a>                    (void);
  95 <font>void</font>                <a href="xmlsec-io.html#XMLSECIOCLEANUPCALLBACKS">xmlSecIOCleanupCallbacks</a>            (void);
  96 <font>int</font>                 <a href="xmlsec-io.html#XMLSECIOREGISTERDEFAULTCALLBACKS">xmlSecIORegisterDefaultCallbacks</a>    (void);
  97 <font>int</font>                 <a href="xmlsec-io.html#XMLSECIOREGISTERCALLBACKS">xmlSecIORegisterCallbacks</a>           (<font>xmlInputMatchCallback</font> matchFunc,
  98                                                          <font>xmlInputOpenCallback</font> openFunc,
  99                                                          <font>xmlInputReadCallback</font> readFunc,
 100                                                          <font>xmlInputCloseCallback</font> closeFunc);
 101 #define             <a href="xmlsec-io.html#XMLSECTRANSFORMINPUTURIID">xmlSecTransformInputURIId</a>
 102 <font>xmlSecTransformId</font>   <a href="xmlsec-io.html#XMLSECTRANSFORMINPUTURIGETKLASS">xmlSecTransformInputURIGetKlass</a>     (void);
 103 <font>int</font>                 <a href="xmlsec-io.html#XMLSECTRANSFORMINPUTURIOPEN">xmlSecTransformInputURIOpen</a>         (<a href="xmlsec-transforms.html#XMLSECTRANSFORM">xmlSecTransformPtr</a> transform,
 104                                                          const <font>xmlChar</font> *uri);</pre>
 105 </div>
 106 <div class="REFSECT1">
 107 <a name="XMLSEC-IO.DESCRIPTION"></a><h2>Description</h2>
 108 <p>Input/output support.</p>
 109 </div>
 110 <div class="REFSECT1">
 111 <a name="XMLSEC-IO.DETAILS"></a><h2>Details</h2>
 112 <div class="REFSECT2">
 113 <a name="XMLSECIOINIT"></a><h3>xmlSecIOInit ()</h3>
 114 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecIOInit                        (void);</pre>
 115 <p>The IO initialization (called from <a href="xmlsec-xmlsec.html#XMLSECINIT"><span class="TYPE">xmlSecInit</span></a> function).
 116 Applications should not call this function directly.</p>
 117 <p></p>
 118 <p></p>
 119 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
 120 <td align="LEFT" valign="TOP"><a name="AEN5311"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 121 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 122 </tr></tbody></table>
 123 </div>
 124 <hr>
 125 <div class="REFSECT2">
 126 <a name="XMLSECIOSHUTDOWN"></a><h3>xmlSecIOShutdown ()</h3>
 127 <pre class="PROGRAMLISTING"><font>void</font>                xmlSecIOShutdown                    (void);</pre>
 128 <p>The IO clenaup (called from <a href="xmlsec-xmlsec.html#XMLSECSHUTDOWN"><span class="TYPE">xmlSecShutdown</span></a> function).
 129 Applications should not call this function directly.</p>
 130 <p></p>
 131 </div>
 132 <hr>
 133 <div class="REFSECT2">
 134 <a name="XMLSECIOCLEANUPCALLBACKS"></a><h3>xmlSecIOCleanupCallbacks ()</h3>
 135 <pre class="PROGRAMLISTING"><font>void</font>                xmlSecIOCleanupCallbacks            (void);</pre>
 136 <p>Clears the entire input callback table. this includes the
 137 compiled-in I/O.</p>
 138 <p></p>
 139 </div>
 140 <hr>
 141 <div class="REFSECT2">
 142 <a name="XMLSECIOREGISTERDEFAULTCALLBACKS"></a><h3>xmlSecIORegisterDefaultCallbacks ()</h3>
 143 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecIORegisterDefaultCallbacks    (void);</pre>
 144 <p>Registers the default compiled-in I/O handlers.</p>
 145 <p></p>
 146 <p></p>
 147 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
 148 <td align="LEFT" valign="TOP"><a name="AEN5343"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 149 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 150 </tr></tbody></table>
 151 </div>
 152 <hr>
 153 <div class="REFSECT2">
 154 <a name="XMLSECIOREGISTERCALLBACKS"></a><h3>xmlSecIORegisterCallbacks ()</h3>
 155 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecIORegisterCallbacks           (<font>xmlInputMatchCallback</font> matchFunc,
 156                                                          <font>xmlInputOpenCallback</font> openFunc,
 157                                                          <font>xmlInputReadCallback</font> readFunc,
 158                                                          <font>xmlInputCloseCallback</font> closeFunc);</pre>
 159 <p>Register a new set of I/O callback for handling parser input.</p>
 160 <p></p>
 161 <p></p>
 162 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 163 <tr>
 164 <td align="LEFT" valign="TOP"><a name="AEN5361"><span style="white-space: nowrap"><code class="PARAMETER">matchFunc</code> :</span></a></td>
 165 <td align="LEFT" valign="TOP"><p>       the protocol match callback.</p></td>
 166 </tr>
 167 <tr>
 168 <td align="LEFT" valign="TOP"><a name="AEN5366"><span style="white-space: nowrap"><code class="PARAMETER">openFunc</code> :</span></a></td>
 169 <td align="LEFT" valign="TOP"><p>               the open stream callback.</p></td>
 170 </tr>
 171 <tr>
 172 <td align="LEFT" valign="TOP"><a name="AEN5371"><span style="white-space: nowrap"><code class="PARAMETER">readFunc</code> :</span></a></td>
 173 <td align="LEFT" valign="TOP"><p>               the read from stream callback.</p></td>
 174 </tr>
 175 <tr>
 176 <td align="LEFT" valign="TOP"><a name="AEN5376"><span style="white-space: nowrap"><code class="PARAMETER">closeFunc</code> :</span></a></td>
 177 <td align="LEFT" valign="TOP"><p>       the close stream callback.</p></td>
 178 </tr>
 179 <tr>
 180 <td align="LEFT" valign="TOP"><a name="AEN5381"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 181 <td align="LEFT" valign="TOP"><p> the 0 on success or a negative value if an error occurs.</p></td>
 182 </tr>
 183 </tbody></table>
 184 </div>
 185 <hr>
 186 <div class="REFSECT2">
 187 <a name="XMLSECTRANSFORMINPUTURIID"></a><h3>xmlSecTransformInputURIId</h3>
 188 <pre class="PROGRAMLISTING">#define             xmlSecTransformInputURIId</pre>
 189 <p>The Input URI transform id.</p>
 190 <p></p>
 191 </div>
 192 <hr>
 193 <div class="REFSECT2">
 194 <a name="XMLSECTRANSFORMINPUTURIGETKLASS"></a><h3>xmlSecTransformInputURIGetKlass ()</h3>
 195 <pre class="PROGRAMLISTING"><font>xmlSecTransformId</font>   xmlSecTransformInputURIGetKlass     (void);</pre>
 196 <p>The input uri transform klass. Reads binary data from an uri.</p>
 197 <p></p>
 198 <p></p>
 199 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
 200 <td align="LEFT" valign="TOP"><a name="AEN5402"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 201 <td align="LEFT" valign="TOP"><p> input URI transform id.</p></td>
 202 </tr></tbody></table>
 203 </div>
 204 <hr>
 205 <div class="REFSECT2">
 206 <a name="XMLSECTRANSFORMINPUTURIOPEN"></a><h3>xmlSecTransformInputURIOpen ()</h3>
 207 <pre class="PROGRAMLISTING"><font>int</font>                 xmlSecTransformInputURIOpen         (<a href="xmlsec-transforms.html#XMLSECTRANSFORM">xmlSecTransformPtr</a> transform,
 208                                                          const <font>xmlChar</font> *uri);</pre>
 209 <p>Opens the given <code class="PARAMETER">uri</code> for reading.</p>
 210 <p></p>
 211 <p></p>
 212 <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
 213 <tr>
 214 <td align="LEFT" valign="TOP"><a name="AEN5419"><span style="white-space: nowrap"><code class="PARAMETER">transform</code> :</span></a></td>
 215 <td align="LEFT" valign="TOP"><p>               the pointer to IO transform.</p></td>
 216 </tr>
 217 <tr>
 218 <td align="LEFT" valign="TOP"><a name="AEN5424"><span style="white-space: nowrap"><code class="PARAMETER">uri</code> :</span></a></td>
 219 <td align="LEFT" valign="TOP"><p>               the URL to open.</p></td>
 220 </tr>
 221 <tr>
 222 <td align="LEFT" valign="TOP"><a name="AEN5429"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
 223 <td align="LEFT" valign="TOP"><p> 0 on success or a negative value otherwise.</p></td>
 224 </tr>
 225 </tbody></table>
 226 </div>
 227 </div>
 228 <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle">
 229 <td align="left"><a accesskey="p" href="xmlsec-errors.html"><b>&lt;&lt;&lt; errors</b></a></td>
 230 <td align="right"><a accesskey="n" href="xmlsec-keyinfo.html"><b>keyinfo &gt;&gt;&gt;</b></a></td>
 231 </tr></table>
 232 </td></tr></table></td>
 233 </tr></table></body>
 234 </html>