diff options
Diffstat (limited to 'docs/api/xmlsec-dl.html')
-rw-r--r-- | docs/api/xmlsec-dl.html | 94 |
1 files changed, 51 insertions, 43 deletions
diff --git a/docs/api/xmlsec-dl.html b/docs/api/xmlsec-dl.html index 9c343a19..1c0702a8 100644 --- a/docs/api/xmlsec-dl.html +++ b/docs/api/xmlsec-dl.html @@ -87,19 +87,19 @@ <h1> <a name="XMLSEC-DL"></a>dl</h1> <div class="REFNAMEDIV"> -<a name="AEN5178"></a><h2>Name</h2>dl -- Dynamic crypto-engine library loading support.</div> +<a name="AEN4295"></a><h2>Name</h2>dl -- Dynamic crypto-engine library loading support.</div> <div class="REFSYNOPSISDIV"> <a name="XMLSEC-DL.SYNOPSIS"></a><h2>Synopsis</h2> -<pre class="SYNOPSIS"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-dl.html#XMLSECCRYPTODLFUNCTIONSREGISTERKEYDATAANDTRANSFORMS">xmlSecCryptoDLFunctionsRegisterKeyDataAndTransforms</a> - (<code class="PARAMETER"><gtkdoclink href="XMLSECCRYPTODLFUNCTIONS"><span class="TYPE">xmlSecCryptoDLFunctionsPtr</span></gtkdoclink> functions</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-dl.html#XMLSECCRYPTODLINIT">xmlSecCryptoDLInit</a> (<code class="PARAMETER"><span class="TYPE">void</span></code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-dl.html#XMLSECCRYPTODLSHUTDOWN">xmlSecCryptoDLShutdown</a> (<code class="PARAMETER"><span class="TYPE">void</span></code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-dl.html#XMLSECCRYPTODLLOADLIBRARY">xmlSecCryptoDLLoadLibrary</a> (<code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *crypto</code>); -<gtkdoclink href="XMLSECCRYPTODLFUNCTIONS"><span class="RETURNVALUE">xmlSecCryptoDLFunctionsPtr</span></gtkdoclink><a href="xmlsec-dl.html#XMLSECCRYPTODLGETLIBRARYFUNCTIONS">xmlSecCryptoDLGetLibraryFunctions</a> - (<code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *crypto</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-dl.html#XMLSECCRYPTODLUNLOADLIBRARY">xmlSecCryptoDLUnloadLibrary</a> (<code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *crypto</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-dl.html#XMLSECCRYPTODLSETFUNCTIONS">xmlSecCryptoDLSetFunctions</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECCRYPTODLFUNCTIONS"><span class="TYPE">xmlSecCryptoDLFunctionsPtr</span></gtkdoclink> functions</code>); -<gtkdoclink href="XMLSECCRYPTODLFUNCTIONS"><span class="RETURNVALUE">xmlSecCryptoDLFunctionsPtr</span></gtkdoclink><a href="xmlsec-dl.html#XMLSECCRYPTODLGETFUNCTIONS">xmlSecCryptoDLGetFunctions</a> (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<pre class="SYNOPSIS"><font>int</font> <a href="xmlsec-dl.html#XMLSECCRYPTODLFUNCTIONSREGISTERKEYDATAANDTRANSFORMS">xmlSecCryptoDLFunctionsRegisterKeyDataAndTransforms</a> + (<font>xmlSecCryptoDLFunctionsPtr</font> functions); +<font>int</font> <a href="xmlsec-dl.html#XMLSECCRYPTODLINIT">xmlSecCryptoDLInit</a> (void); +<font>int</font> <a href="xmlsec-dl.html#XMLSECCRYPTODLSHUTDOWN">xmlSecCryptoDLShutdown</a> (void); +<font>int</font> <a href="xmlsec-dl.html#XMLSECCRYPTODLLOADLIBRARY">xmlSecCryptoDLLoadLibrary</a> (const <font>xmlChar</font> *crypto); +<font>xmlSecCryptoDLFunctionsPtr</font> <a href="xmlsec-dl.html#XMLSECCRYPTODLGETLIBRARYFUNCTIONS">xmlSecCryptoDLGetLibraryFunctions</a> + (const <font>xmlChar</font> *crypto); +<font>int</font> <a href="xmlsec-dl.html#XMLSECCRYPTODLUNLOADLIBRARY">xmlSecCryptoDLUnloadLibrary</a> (const <font>xmlChar</font> *crypto); +<font>int</font> <a href="xmlsec-dl.html#XMLSECCRYPTODLSETFUNCTIONS">xmlSecCryptoDLSetFunctions</a> (<font>xmlSecCryptoDLFunctionsPtr</font> functions); +<font>xmlSecCryptoDLFunctionsPtr</font> <a href="xmlsec-dl.html#XMLSECCRYPTODLGETFUNCTIONS">xmlSecCryptoDLGetFunctions</a> (void);</pre> </div> <div class="REFSECT1"> <a name="XMLSEC-DL.DESCRIPTION"></a><h2>Description</h2> @@ -109,17 +109,18 @@ <a name="XMLSEC-DL.DETAILS"></a><h2>Details</h2> <div class="REFSECT2"> <a name="XMLSECCRYPTODLFUNCTIONSREGISTERKEYDATAANDTRANSFORMS"></a><h3>xmlSecCryptoDLFunctionsRegisterKeyDataAndTransforms ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecCryptoDLFunctionsRegisterKeyDataAndTransforms - (<code class="PARAMETER"><gtkdoclink href="XMLSECCRYPTODLFUNCTIONS"><span class="TYPE">xmlSecCryptoDLFunctionsPtr</span></gtkdoclink> functions</code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecCryptoDLFunctionsRegisterKeyDataAndTransforms + (<font>xmlSecCryptoDLFunctionsPtr</font> functions);</pre> <p>Registers the key data and transforms klasses from <code class="PARAMETER">functions</code> table in xmlsec.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5247"><span style="white-space: nowrap"><code class="PARAMETER">functions</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the functions table.</p></td> +<td align="LEFT" valign="TOP"><a name="AEN4338"><span style="white-space: nowrap"><code class="PARAMETER">functions</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the functions table.</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5252"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN4343"><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 if an error occurs.</p></td> </tr> </tbody></table> @@ -127,42 +128,45 @@ <hr> <div class="REFSECT2"> <a name="XMLSECCRYPTODLINIT"></a><h3>xmlSecCryptoDLInit ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecCryptoDLInit (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecCryptoDLInit (void);</pre> <p>Initializes dynamic loading engine. This is an internal function and should not be called by application directly.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN5268"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN4357"><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 if an error occurs.</p></td> </tr></tbody></table> </div> <hr> <div class="REFSECT2"> <a name="XMLSECCRYPTODLSHUTDOWN"></a><h3>xmlSecCryptoDLShutdown ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecCryptoDLShutdown (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecCryptoDLShutdown (void);</pre> <p>Shutdowns dynamic loading engine. This is an internal function and should not be called by application directly.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN5284"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN4371"><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 if an error occurs.</p></td> </tr></tbody></table> </div> <hr> <div class="REFSECT2"> <a name="XMLSECCRYPTODLLOADLIBRARY"></a><h3>xmlSecCryptoDLLoadLibrary ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecCryptoDLLoadLibrary (<code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *crypto</code>);</pre> -<p>Loads the xmlsec-<crypto> library. This function is NOT thread safe, +<pre class="PROGRAMLISTING"><font>int</font> xmlSecCryptoDLLoadLibrary (const <font>xmlChar</font> *crypto);</pre> +<p>Loads the xmlsec-<crypto> library. This function is NOT thread safe, application MUST NOT call <a href="xmlsec-dl.html#XMLSECCRYPTODLLOADLIBRARY"><span class="TYPE">xmlSecCryptoDLLoadLibrary</span></a>, <a href="xmlsec-dl.html#XMLSECCRYPTODLGETLIBRARYFUNCTIONS"><span class="TYPE">xmlSecCryptoDLGetLibraryFunctions</span></a>, and <a href="xmlsec-dl.html#XMLSECCRYPTODLUNLOADLIBRARY"><span class="TYPE">xmlSecCryptoDLUnloadLibrary</span></a> functions from multiple threads.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5307"><span style="white-space: nowrap"><code class="PARAMETER">crypto</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the desired crypto library name ("openssl", "nss", ...).</p></td> +<td align="LEFT" valign="TOP"><a name="AEN4392"><span style="white-space: nowrap"><code class="PARAMETER">crypto</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the desired crypto library name ("openssl", "nss", ...).</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5312"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN4397"><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 if an error occurs.</p></td> </tr> </tbody></table> @@ -170,19 +174,20 @@ and <a href="xmlsec-dl.html#XMLSECCRYPTODLUNLOADLIBRARY"><span class="TYPE">xmlS <hr> <div class="REFSECT2"> <a name="XMLSECCRYPTODLGETLIBRARYFUNCTIONS"></a><h3>xmlSecCryptoDLGetLibraryFunctions ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLSECCRYPTODLFUNCTIONS"><span class="RETURNVALUE">xmlSecCryptoDLFunctionsPtr</span></gtkdoclink> xmlSecCryptoDLGetLibraryFunctions - (<code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *crypto</code>);</pre> -<p>Loads the xmlsec-<crypto> library and gets global crypto functions/transforms/keys data/keys store -table. This function is NOT thread safe, application MUST NOT call <a href="xmlsec-dl.html#XMLSECCRYPTODLLOADLIBRARY"><span class="TYPE">xmlSecCryptoDLLoadLibrary</span></a>, +<pre class="PROGRAMLISTING"><font>xmlSecCryptoDLFunctionsPtr</font> xmlSecCryptoDLGetLibraryFunctions + (const <font>xmlChar</font> *crypto);</pre> +<p>Loads the xmlsec-<crypto> library and gets global crypto functions/transforms/keys data/keys store +table. This function is NOT thread safe, application MUST NOT call <a href="xmlsec-dl.html#XMLSECCRYPTODLLOADLIBRARY"><span class="TYPE">xmlSecCryptoDLLoadLibrary</span></a>, <a href="xmlsec-dl.html#XMLSECCRYPTODLGETLIBRARYFUNCTIONS"><span class="TYPE">xmlSecCryptoDLGetLibraryFunctions</span></a>, and <a href="xmlsec-dl.html#XMLSECCRYPTODLUNLOADLIBRARY"><span class="TYPE">xmlSecCryptoDLUnloadLibrary</span></a> functions from multiple threads.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5335"><span style="white-space: nowrap"><code class="PARAMETER">crypto</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the desired crypto library name ("openssl", "nss", ...).</p></td> +<td align="LEFT" valign="TOP"><a name="AEN4418"><span style="white-space: nowrap"><code class="PARAMETER">crypto</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the desired crypto library name ("openssl", "nss", ...).</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5340"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN4423"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p> the table or NULL if an error occurs.</p></td> </tr> </tbody></table> @@ -190,19 +195,20 @@ table. This function is NOT thread safe, application MUST NOT call <a href="xmls <hr> <div class="REFSECT2"> <a name="XMLSECCRYPTODLUNLOADLIBRARY"></a><h3>xmlSecCryptoDLUnloadLibrary ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecCryptoDLUnloadLibrary (<code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *crypto</code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecCryptoDLUnloadLibrary (const <font>xmlChar</font> *crypto);</pre> <p>Unloads the xmlsec-<crypto> library. All pointers to this library -functions tables became invalid. This function is NOT thread safe, +functions tables became invalid. This function is NOT thread safe, application MUST NOT call <a href="xmlsec-dl.html#XMLSECCRYPTODLLOADLIBRARY"><span class="TYPE">xmlSecCryptoDLLoadLibrary</span></a>, <a href="xmlsec-dl.html#XMLSECCRYPTODLGETLIBRARYFUNCTIONS"><span class="TYPE">xmlSecCryptoDLGetLibraryFunctions</span></a>, and <a href="xmlsec-dl.html#XMLSECCRYPTODLUNLOADLIBRARY"><span class="TYPE">xmlSecCryptoDLUnloadLibrary</span></a> functions from multiple threads.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5363"><span style="white-space: nowrap"><code class="PARAMETER">crypto</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the desired crypto library name ("openssl", "nss", ...).</p></td> +<td align="LEFT" valign="TOP"><a name="AEN4444"><span style="white-space: nowrap"><code class="PARAMETER">crypto</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the desired crypto library name ("openssl", "nss", ...).</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5368"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN4449"><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 if an error occurs.</p></td> </tr> </tbody></table> @@ -210,16 +216,17 @@ and <a href="xmlsec-dl.html#XMLSECCRYPTODLUNLOADLIBRARY"><span class="TYPE">xmlS <hr> <div class="REFSECT2"> <a name="XMLSECCRYPTODLSETFUNCTIONS"></a><h3>xmlSecCryptoDLSetFunctions ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecCryptoDLSetFunctions (<code class="PARAMETER"><gtkdoclink href="XMLSECCRYPTODLFUNCTIONS"><span class="TYPE">xmlSecCryptoDLFunctionsPtr</span></gtkdoclink> functions</code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecCryptoDLSetFunctions (<font>xmlSecCryptoDLFunctionsPtr</font> functions);</pre> <p>Sets global crypto functions/transforms/keys data/keys store table.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5385"><span style="white-space: nowrap"><code class="PARAMETER">functions</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the new table</p></td> +<td align="LEFT" valign="TOP"><a name="AEN4464"><span style="white-space: nowrap"><code class="PARAMETER">functions</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the new table</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN5390"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN4469"><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 if an error occurs.</p></td> </tr> </tbody></table> @@ -227,11 +234,12 @@ and <a href="xmlsec-dl.html#XMLSECCRYPTODLUNLOADLIBRARY"><span class="TYPE">xmlS <hr> <div class="REFSECT2"> <a name="XMLSECCRYPTODLGETFUNCTIONS"></a><h3>xmlSecCryptoDLGetFunctions ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLSECCRYPTODLFUNCTIONS"><span class="RETURNVALUE">xmlSecCryptoDLFunctionsPtr</span></gtkdoclink> xmlSecCryptoDLGetFunctions (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<pre class="PROGRAMLISTING"><font>xmlSecCryptoDLFunctionsPtr</font> xmlSecCryptoDLGetFunctions (void);</pre> <p>Gets global crypto functions/transforms/keys data/keys store table.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN5406"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN4483"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p> the table.</p></td> </tr></tbody></table> </div> |