<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>io</title>
<meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.7">
<link rel="HOME" title="XML Security Library Reference Manual" href="index.html">
<link rel="UP" title="XML Security Core Library API Reference." href="xmlsec-ref.html">
<link rel="PREVIOUS" title="errors" href="xmlsec-errors.html">
<link rel="NEXT" title="keyinfo" href="xmlsec-keyinfo.html">
<meta name="GENERATOR" content="GTK-Doc V1.2 (SGML mode)">
<style type="text/css">.synopsis, .classsynopsis {
background: #eeeeee;
border: solid 1px #aaaaaa;
padding: 0.5em;
}
.programlisting {
background: #eeeeff;
border: solid 1px #aaaaff;
padding: 0.5em;
}
.variablelist {
padding: 4px;
margin-left: 3em;
}
.navigation {
background: #ffeeee;
border: solid 1px #ffaaaa;
margin-top: 0.5em;
margin-bottom: 0.5em;
}
.navigation a {
color: #770000;
}
.navigation a:visited {
color: #550000;
}
.navigation .title {
font-size: 200%;
}</style>
</head>
<body><table witdh="100%" valign="top"><tr valign="top">
<td valign="top" align="left" width="210">
<img src="../images/logo.gif" alt="XML Security Library" border="0"><p></p>
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="../download.html">Download</a></li>
<li><a href="../news.html">News</a></li>
<li><a href="../documentation.html">Documentation</a></li>
<ul>
<li><a href="../faq.html">FAQ</a></li>
<li><a href="../api/xmlsec-notes.html">Tutorial</a></li>
<li><a href="../api/xmlsec-reference.html">API reference</a></li>
<li><a href="../api/xmlsec-examples.html">Examples</a></li>
</ul>
<li><a href="../xmldsig.html">XML Digital Signature</a></li>
<ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul>
<li><a href="../xmlenc.html">XML Encryption</a></li>
<li><a href="../c14n.html">XML Canonicalization</a></li>
<li><a href="../bugs.html">Reporting Bugs</a></li>
<li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li>
<li><a href="../related.html">Related</a></li>
<li><a href="../authors.html">Authors</a></li>
</ul>
<table width="100%">
<tr>
<td width="15"></td>
<td><a href="http://xmlsoft.org/"><img src="../images/libxml2-logo.png" alt="LibXML2" border="0"></a></td>
</tr>
<tr>
<td width="15"></td>
<td><a href="http://xmlsoft.org/XSLT"><img src="../images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td>
</tr>
<tr>
<td width="15"></td>
<td><a href="http://www.openssl.org/"><img src="../images/openssl-logo.png" alt="OpenSSL" border="0"></a></td>
</tr>
<!--Links - start--><!--Links - end-->
</table>
</td>
<td valign="top"><table width="100%" valign="top"><tr><td valign="top" align="left" id="xmlsecContent">
<table width="100%" class="navigation" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="xmlsec-errors.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="xmlsec-ref.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">XML Security Library Reference Manual</th>
<td><a accesskey="n" href="xmlsec-keyinfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<h1>
<a name="XMLSEC-IO"></a>io</h1>
<div class="REFNAMEDIV">
<a name="AEN5493"></a><h2>Name</h2>io--Input/output support.</div>
<div class="REFSYNOPSISDIV">
<a name="AEN5496"></a><h2>Synopsis</h2>
<pre class="SYNOPSIS">
<font>int</font> <a href="xmlsec-io.html#XMLSECIOINIT">xmlSecIOInit</a> (void);
<font>void</font> <a href="xmlsec-io.html#XMLSECIOSHUTDOWN">xmlSecIOShutdown</a> (void);
<font>void</font> <a href="xmlsec-io.html#XMLSECIOCLEANUPCALLBACKS">xmlSecIOCleanupCallbacks</a> (void);
<font>int</font> <a href="xmlsec-io.html#XMLSECIOREGISTERDEFAULTCALLBACKS">xmlSecIORegisterDefaultCallbacks</a>
(void);
<font>int</font> <a href="xmlsec-io.html#XMLSECIOREGISTERCALLBACKS">xmlSecIORegisterCallbacks</a> (<font>xmlInputMatchCallback</font> matchFunc,
<font>xmlInputOpenCallback</font> openFunc,
<font>xmlInputReadCallback</font> readFunc,
<font>xmlInputCloseCallback</font> closeFunc);
#define <a href="xmlsec-io.html#XMLSECTRANSFORMINPUTURIID">xmlSecTransformInputURIId</a>
<font>xmlSecTransformId</font> <a href="xmlsec-io.html#XMLSECTRANSFORMINPUTURIGETKLASS">xmlSecTransformInputURIGetKlass</a>
(void);
<font>int</font> <a href="xmlsec-io.html#XMLSECTRANSFORMINPUTURIOPEN">xmlSecTransformInputURIOpen</a> (<a href="xmlsec-transforms.html#XMLSECTRANSFORM">xmlSecTransformPtr</a> transform,
const <font>xmlChar</font> *uri);</pre>
</div>
<div class="REFSECT1">
<a name="AEN5520"></a><h2>Description</h2>
<p>Input/output support.</p>
</div>
<div class="REFSECT1">
<a name="AEN5523"></a><h2>Details</h2>
<div class="REFSECT2">
<a name="AEN5525"></a><h3>
<a name="XMLSECIOINIT"></a>xmlSecIOInit ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecIOInit (void);</pre>
<p>The IO initialization (called from <a href="xmlsec-xmlsec.html#XMLSECINIT"><span class="TYPE">xmlSecInit</span></a> function).
Applications should not call this function directly.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN5537"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN5542"></a><h3>
<a name="XMLSECIOSHUTDOWN"></a>xmlSecIOShutdown ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> xmlSecIOShutdown (void);</pre>
<p>The IO clenaup (called from <a href="xmlsec-xmlsec.html#XMLSECSHUTDOWN"><span class="TYPE">xmlSecShutdown</span></a> function).
Applications should not call this function directly.</p>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN5553"></a><h3>
<a name="XMLSECIOCLEANUPCALLBACKS"></a>xmlSecIOCleanupCallbacks ()</h3>
<pre class="PROGRAMLISTING"><font>void</font> xmlSecIOCleanupCallbacks (void);</pre>
<p>Clears the entire input callback table. this includes the
compiled-in I/O.</p>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN5562"></a><h3>
<a name="XMLSECIOREGISTERDEFAULTCALLBACKS"></a>xmlSecIORegisterDefaultCallbacks ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecIORegisterDefaultCallbacks
(void);</pre>
<p>Registers the default compiled-in I/O handlers.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN5572"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN5577"></a><h3>
<a name="XMLSECIOREGISTERCALLBACKS"></a>xmlSecIORegisterCallbacks ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecIORegisterCallbacks (<font>xmlInputMatchCallback</font> matchFunc,
<font>xmlInputOpenCallback</font> openFunc,
<font>xmlInputReadCallback</font> readFunc,
<font>xmlInputCloseCallback</font> closeFunc);</pre>
<p>Register a new set of I/O callback for handling parser input.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN5591"><span style="white-space: nowrap"><var class="PARAMETER">matchFunc</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the protocol match callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN5596"><span style="white-space: nowrap"><var class="PARAMETER">openFunc</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the open stream callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN5601"><span style="white-space: nowrap"><var class="PARAMETER">readFunc</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the read from stream callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN5606"><span style="white-space: nowrap"><var class="PARAMETER">closeFunc</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the close stream callback.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN5611"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>the 0 on success or a negative value if an error occurs.</p></td>
</tr>
</tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN5616"></a><h3>
<a name="XMLSECTRANSFORMINPUTURIID"></a>xmlSecTransformInputURIId</h3>
<pre class="PROGRAMLISTING">#define xmlSecTransformInputURIId</pre>
<p>The Input URI transform id.</p>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN5624"></a><h3>
<a name="XMLSECTRANSFORMINPUTURIGETKLASS"></a>xmlSecTransformInputURIGetKlass ()</h3>
<pre class="PROGRAMLISTING"><font>xmlSecTransformId</font> xmlSecTransformInputURIGetKlass
(void);</pre>
<p>The input uri transform klass. Reads binary data from an uri.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN5634"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>input URI transform id.</p></td>
</tr></tbody></table>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN5639"></a><h3>
<a name="XMLSECTRANSFORMINPUTURIOPEN"></a>xmlSecTransformInputURIOpen ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecTransformInputURIOpen (<a href="xmlsec-transforms.html#XMLSECTRANSFORM">xmlSecTransformPtr</a> transform,
const <font>xmlChar</font> *uri);</pre>
<p>Opens the given <var class="PARAMETER">uri</var> for reading.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN5652"><span style="white-space: nowrap"><var class="PARAMETER">transform</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the pointer to IO transform.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN5657"><span style="white-space: nowrap"><var class="PARAMETER">uri</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the URL to open.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN5662"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td>
<td align="LEFT" valign="TOP"><p>0 on success or a negative value otherwise.</p></td>
</tr>
</tbody></table>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle">
<td align="left"><a accesskey="p" href="xmlsec-errors.html"><b><<<errors</b></a></td>
<td align="right"><a accesskey="n" href="xmlsec-keyinfo.html"><b>keyinfo>>></b></a></td>
</tr></table>
</td></tr></table></td>
</tr></table></body>
</html>
