<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.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="xmlenc" href="xmlsec-xmlenc.html">
<link rel="NEXT" title="xmltree" href="xmlsec-xmltree.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-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="AEN19768"></a><h2>Name</h2>xmlsec--Utility functions.</div>
<div class="REFSYNOPSISDIV">
<a name="AEN19771"></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#XMLSECBYTE">xmlSecByte</a>
<font>int</font> <a href="xmlsec-xmlsec.html#XMLSECINIT">xmlSecInit</a> (void);
<font>int</font> <a href="xmlsec-xmlsec.html#XMLSECSHUTDOWN">xmlSecShutdown</a> (void);
#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>;
<font>int</font> <a href="xmlsec-xmlsec.html#XMLSECCHECKVERSIONEXT">xmlSecCheckVersionExt</a> (<font>int</font> major,
<font>int</font> minor,
<font>int</font> subminor,
<a href="xmlsec-xmlsec.html#XMLSECCHECKVERSIONMODE">xmlSecCheckVersionMode</a> mode);
#define <a href="xmlsec-xmlsec.html#ATTRIBUTE-UNUSED-CAPS">ATTRIBUTE_UNUSED</a></pre>
</div>
<div class="REFSECT1">
<a name="AEN19791"></a><h2>Description</h2>
<p>Utility functions.</p>
</div>
<div class="REFSECT1">
<a name="AEN19794"></a><h2>Details</h2>
<div class="REFSECT2">
<a name="AEN19796"></a><h3>
<a name="XMLSECPTR"></a>xmlSecPtr</h3>
<pre class="PROGRAMLISTING">typedef void* xmlSecPtr;</pre>
<p>Void pointer.</p>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN19804"></a><h3>
<a name="XMLSECSIZE"></a>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>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN19812"></a><h3>
<a name="XMLSECBYTE"></a>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>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN19820"></a><h3>
<a name="XMLSECINIT"></a>xmlSecInit ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecInit (void);</pre>
<p>Initializes XML Security Library. The depended libraries
(LibXML and LibXSLT) must be initialized before.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN19830"><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="AEN19835"></a><h3>
<a name="XMLSECSHUTDOWN"></a>xmlSecShutdown ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecShutdown (void);</pre>
<p>Clean ups the XML Security Library.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr>
<td align="LEFT" valign="TOP"><a name="AEN19845"><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="AEN19850"></a><h3>
<a name="XMLSECCHECKVERSIONEXACT"></a>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>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN19858"></a><h3>
<a name="XMLSECCHECKVERSION"></a>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>
<p></p>
</div>
<hr>
<div class="REFSECT2">
<a name="AEN19866"></a><h3>
<a name="XMLSECCHECKVERSIONMODE"></a>enum xmlSecCheckVersionMode</h3>
<pre class="PROGRAMLISTING">typedef enum {
xmlSecCheckVersionExact = 0,
xmlSecCheckVersionABICompatible
} xmlSecCheckVersionMode;</pre>
<p>The xmlsec library version mode.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN19875"><span style="white-space: nowrap"><var class="LITERAL">xmlSecCheckVersionExact</var></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="AEN19880"><span style="white-space: nowrap"><var class="LITERAL">xmlSecCheckVersionABICompatible</var></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="AEN19885"></a><h3>
<a name="XMLSECCHECKVERSIONEXT"></a>xmlSecCheckVersionExt ()</h3>
<pre class="PROGRAMLISTING"><font>int</font> xmlSecCheckVersionExt (<font>int</font> major,
<font>int</font> minor,
<font>int</font> subminor,
<a href="xmlsec-xmlsec.html#XMLSECCHECKVERSIONMODE">xmlSecCheckVersionMode</a> mode);</pre>
<p>Checks if the loaded version of xmlsec library could be used.</p>
<p></p>
<p></p>
<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN19899"><span style="white-space: nowrap"><var class="PARAMETER">major</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the major version number.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN19904"><span style="white-space: nowrap"><var class="PARAMETER">minor</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the minor version number.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN19909"><span style="white-space: nowrap"><var class="PARAMETER">subminor</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the subminor version number.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN19914"><span style="white-space: nowrap"><var class="PARAMETER">mode</var>:</span></a></td>
<td align="LEFT" valign="TOP"><p> the version check mode.</p></td>
</tr>
<tr>
<td align="LEFT" valign="TOP"><a name="AEN19919"><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="AEN19924"></a><h3>
<a name="ATTRIBUTE-UNUSED-CAPS"></a>ATTRIBUTE_UNUSED</h3>
<pre class="PROGRAMLISTING">#define ATTRIBUTE_UNUSED</pre>
<p>Macro used to signal to GCC unused function parameters</p>
<p></p>
</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>
