diff options
Diffstat (limited to 'docs/api/xmlsec-xmlsec.html')
-rw-r--r-- | docs/api/xmlsec-xmlsec.html | 300 |
1 files changed, 300 insertions, 0 deletions
diff --git a/docs/api/xmlsec-xmlsec.html b/docs/api/xmlsec-xmlsec.html new file mode 100644 index 00000000..f83142b5 --- /dev/null +++ b/docs/api/xmlsec-xmlsec.html @@ -0,0 +1,300 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>xmlsec</title> +<meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79"> +<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="xmlenc" href="xmlsec-xmlenc.html"> +<link rel="NEXT" title="xmltree" href="xmlsec-xmltree.html"> +<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-xmlenc.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-xmltree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<h1> +<a name="XMLSEC-XMLSEC"></a>xmlsec</h1> +<div class="REFNAMEDIV"> +<a name="AEN23181"></a><h2>Name</h2>xmlsec -- Utility functions.</div> +<div class="REFSYNOPSISDIV"> +<a name="XMLSEC-XMLSEC.SYNOPSIS"></a><h2>Synopsis</h2> +<pre class="SYNOPSIS">typedef <font>xmlSecPtr</font>; +#define <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> +#define <a href="xmlsec-xmlsec.html#XMLSEC-SIZE-BAD-CAST:CAPS">XMLSEC_SIZE_BAD_CAST</a> (val) +#define <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> +<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-xmlsec.html#XMLSECINIT">xmlSecInit</a> (<code class="PARAMETER"><span class="TYPE">void</span></code>); +<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-xmlsec.html#XMLSECSHUTDOWN">xmlSecShutdown</a> (<code class="PARAMETER"><span class="TYPE">void</span></code>); +#define <a href="xmlsec-xmlsec.html#XMLSECCHECKVERSIONEXACT">xmlSecCheckVersionExact</a> +#define <a href="xmlsec-xmlsec.html#XMLSECCHECKVERSION">xmlSecCheckVersion</a> +enum <a href="xmlsec-xmlsec.html#XMLSECCHECKVERSIONMODE">xmlSecCheckVersionMode</a>; +<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-xmlsec.html#XMLSECCHECKVERSIONEXT">xmlSecCheckVersionExt</a> (<code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> major</code>, + <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> minor</code>, + <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> subminor</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECCHECKVERSIONMODE"><span class="TYPE">xmlSecCheckVersionMode</span></a> mode</code>); +#define <a href="xmlsec-xmlsec.html#ATTRIBUTE-UNUSED:CAPS">ATTRIBUTE_UNUSED</a> +#define <a href="xmlsec-xmlsec.html#XMLSEC-PTR-TO-FUNC-IMPL:CAPS">XMLSEC_PTR_TO_FUNC_IMPL</a> (func_type) +#define <a href="xmlsec-xmlsec.html#XMLSEC-PTR-TO-FUNC:CAPS">XMLSEC_PTR_TO_FUNC</a> (func_type, + ptr) +#define <a href="xmlsec-xmlsec.html#XMLSEC-FUNC-TO-PTR:CAPS">XMLSEC_FUNC_TO_PTR</a> (func_type, + func)</pre> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-XMLSEC.DESCRIPTION"></a><h2>Description</h2> +<p>Utility functions.</p> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-XMLSEC.DETAILS"></a><h2>Details</h2> +<div class="REFSECT2"> +<a name="XMLSECPTR"></a><h3>xmlSecPtr</h3> +<pre class="PROGRAMLISTING">typedef void* xmlSecPtr;</pre> +<p>Void pointer.</p> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECSIZE"></a><h3>xmlSecSize</h3> +<pre class="PROGRAMLISTING">#define xmlSecSize</pre> +<p>Size of something. Should be typedef instead of define +but it will break ABI (todo).</p> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSEC-SIZE-BAD-CAST:CAPS"></a><h3>XMLSEC_SIZE_BAD_CAST()</h3> +<pre class="PROGRAMLISTING">#define XMLSEC_SIZE_BAD_CAST(val) ((xmlSecSize)(val))</pre> +<p>Bad cast to xmlSecSize</p> +<p></p> +<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> +<td align="LEFT" valign="TOP"><a name="AEN23247"><span style="white-space: nowrap"><code class="PARAMETER">val</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the value to cast</p></td> +</tr></tbody></table> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECBYTE"></a><h3>xmlSecByte</h3> +<pre class="PROGRAMLISTING">#define xmlSecByte unsigned char</pre> +<p>One byte. Should be typedef instead of define +but it will break ABI (todo).</p> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECINIT"></a><h3>xmlSecInit ()</h3> +<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecInit (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<p>Initializes XML Security Library. The depended libraries +(LibXML and LibXSLT) must be initialized before.</p> +<p></p> +<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> +<td align="LEFT" valign="TOP"><a name="AEN23269"><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="XMLSECSHUTDOWN"></a><h3>xmlSecShutdown ()</h3> +<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecShutdown (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<p>Clean ups the XML Security Library.</p> +<p></p> +<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> +<td align="LEFT" valign="TOP"><a name="AEN23285"><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="XMLSECCHECKVERSIONEXACT"></a><h3>xmlSecCheckVersionExact</h3> +<pre class="PROGRAMLISTING">#define xmlSecCheckVersionExact()</pre> +<p>Macro. Returns 1 if the loaded xmlsec library version exactly matches +the one used to compile the caller, 0 if it does not or a negative +value if an error occurs.</p> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECCHECKVERSION"></a><h3>xmlSecCheckVersion</h3> +<pre class="PROGRAMLISTING">#define xmlSecCheckVersion()</pre> +<p>Macro. Returns 1 if the loaded xmlsec library version ABI compatible with +the one used to compile the caller, 0 if it does not or a negative +value if an error occurs.</p> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECCHECKVERSIONMODE"></a><h3>enum xmlSecCheckVersionMode</h3> +<pre class="PROGRAMLISTING">typedef enum { + xmlSecCheckVersionExactMatch = 0, + xmlSecCheckVersionABICompatible +} xmlSecCheckVersionMode;</pre> +<p>The xmlsec library version mode.</p> +<p></p> +<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<tr> +<td align="LEFT" valign="TOP"><a name="XMLSECCHECKVERSIONEXACTMATCH"><span style="white-space: nowrap"><tt class="LITERAL">xmlSecCheckVersionExactMatch</tt></span></a></td> +<td align="LEFT" valign="TOP"><p>the version should match exactly.</p></td> +</tr> +<tr> +<td align="LEFT" valign="TOP"><a name="XMLSECCHECKVERSIONABICOMPATIBLE"><span style="white-space: nowrap"><tt class="LITERAL">xmlSecCheckVersionABICompatible</tt></span></a></td> +<td align="LEFT" valign="TOP"><p>the version should be ABI compatible.</p></td> +</tr> +</tbody></table> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECCHECKVERSIONEXT"></a><h3>xmlSecCheckVersionExt ()</h3> +<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecCheckVersionExt (<code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> major</code>, + <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> minor</code>, + <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> subminor</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECCHECKVERSIONMODE"><span class="TYPE">xmlSecCheckVersionMode</span></a> mode</code>);</pre> +<p>Checks if the loaded version of xmlsec library could be used.</p> +<p></p> +<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23340"><span style="white-space: nowrap"><code class="PARAMETER">major</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the major version number.</p></td> +</tr> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23345"><span style="white-space: nowrap"><code class="PARAMETER">minor</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the minor version number.</p></td> +</tr> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23350"><span style="white-space: nowrap"><code class="PARAMETER">subminor</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the subminor version number.</p></td> +</tr> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23355"><span style="white-space: nowrap"><code class="PARAMETER">mode</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the version check mode.</p></td> +</tr> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23360"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><p> 1 if the loaded xmlsec library version is OK to use +0 if it is not or a negative value if an error occurs.</p></td> +</tr> +</tbody></table> +</div> +<hr> +<div class="REFSECT2"> +<a name="ATTRIBUTE-UNUSED:CAPS"></a><h3>ATTRIBUTE_UNUSED</h3> +<pre class="PROGRAMLISTING">#define ATTRIBUTE_UNUSED</pre> +<p>Macro used to signal to GCC unused function parameters</p> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSEC-PTR-TO-FUNC-IMPL:CAPS"></a><h3>XMLSEC_PTR_TO_FUNC_IMPL()</h3> +<pre class="PROGRAMLISTING">#define XMLSEC_PTR_TO_FUNC_IMPL(func_type)</pre> +<p>Macro declares helper functions to convert between "void *" pointer and +function pointer.</p> +<p></p> +<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> +<td align="LEFT" valign="TOP"><a name="AEN23378"><span style="white-space: nowrap"><code class="PARAMETER">func_type</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the function type.</p></td> +</tr></tbody></table> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSEC-PTR-TO-FUNC:CAPS"></a><h3>XMLSEC_PTR_TO_FUNC()</h3> +<pre class="PROGRAMLISTING">#define XMLSEC_PTR_TO_FUNC(func_type, ptr)</pre> +<p>Macro converts from "void*" pointer to "func_type" function pointer.</p> +<p></p> +<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23390"><span style="white-space: nowrap"><code class="PARAMETER">func_type</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the function type.</p></td> +</tr> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23395"><span style="white-space: nowrap"><code class="PARAMETER">ptr</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the "void*" pointer to be converted.</p></td> +</tr> +</tbody></table> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSEC-FUNC-TO-PTR:CAPS"></a><h3>XMLSEC_FUNC_TO_PTR()</h3> +<pre class="PROGRAMLISTING">#define XMLSEC_FUNC_TO_PTR(func_type, func)</pre> +<p>Macro converts from "func_type" function pointer to "void*" pointer.</p> +<p></p> +<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23407"><span style="white-space: nowrap"><code class="PARAMETER">func_type</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the function type.</p></td> +</tr> +<tr> +<td align="LEFT" valign="TOP"><a name="AEN23412"><span style="white-space: nowrap"><code class="PARAMETER">func</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p>the "func_type" function pointer to be converted.</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-xmlenc.html"><b><<< xmlenc</b></a></td> +<td align="right"><a accesskey="n" href="xmlsec-xmltree.html"><b>xmltree >>></b></a></td> +</tr></table> +</td></tr></table></td> +</tr></table></body> +</html> |