diff options
Diffstat (limited to 'docs/api/xmlsec-mscrypto-keysstore.html')
-rw-r--r-- | docs/api/xmlsec-mscrypto-keysstore.html | 267 |
1 files changed, 189 insertions, 78 deletions
diff --git a/docs/api/xmlsec-mscrypto-keysstore.html b/docs/api/xmlsec-mscrypto-keysstore.html index 0ec0d207..8e0c5855 100644 --- a/docs/api/xmlsec-mscrypto-keysstore.html +++ b/docs/api/xmlsec-mscrypto-keysstore.html @@ -36,8 +36,31 @@ .navigation .title { font-size: 200%; }</style> +<style type="text/css"> +table.CALSTABLE > tbody > tr:nth-child(1) > td:nth-child(1) { + width: 20em; +} +.synopsis, .classsynopsis { + background: #eeeeee; + border: solid 1px #aaaaaa; +} +.programlisting { + background: #eeeeee; + border: solid 1px #000000; +} +.navigation { + background: #eeeeee; + border: solid 1px #000000; +} +.navigation a { + color: initial; +} +.navigation a:visited { + color: initial; +} +</style> </head> -<body><table witdh="100%" valign="top"><tr valign="top"> +<body><table width="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> @@ -78,126 +101,214 @@ </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-mscrypto-crypto.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="xmlsec-mscrypto-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> +<td><a accesskey="p" href="xmlsec-mscrypto-crypto.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="xmlsec-mscrypto-ref.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <th width="100%" align="center">XML Security Library Reference Manual</th> -<td><a accesskey="n" href="xmlsec-mscrypto-x509.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="xmlsec-mscrypto-x509.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <h1> <a name="XMLSEC-MSCRYPTO-KEYSSTORE"></a>keysstore</h1> <div class="REFNAMEDIV"> -<a name="AEN41416"></a><h2>Name</h2>keysstore -- Keys store implementation for MS Crypto.</div> -<div class="REFSYNOPSISDIV"> -<a name="XMLSEC-MSCRYPTO-KEYSSTORE.SYNOPSIS"></a><h2>Synopsis</h2> -<pre class="SYNOPSIS"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTOREADOPTKEY">xmlSecMSCryptoKeysStoreAdoptKey</a> (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, - <code class="PARAMETER"><a href="xmlsec-keys.html#XMLSECKEY"><span class="TYPE">xmlSecKeyPtr</span></a> key</code>); -<gtkdoclink href="XMLSECKEYSTOREID"><span class="RETURNVALUE">xmlSecKeyStoreId</span></gtkdoclink><a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTOREGETKLASS">xmlSecMSCryptoKeysStoreGetKlass</a> (<code class="PARAMETER"><span class="TYPE">void</span></code>); -#define <a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTOREID">xmlSecMSCryptoKeysStoreId</a> -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTORELOAD">xmlSecMSCryptoKeysStoreLoad</a> (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, - <code class="PARAMETER">const <gtkdoclink href="CHAR"><span class="TYPE">char</span></gtkdoclink> *uri</code>, - <code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> keysMngr</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTORESAVE">xmlSecMSCryptoKeysStoreSave</a> (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, - <code class="PARAMETER">const <gtkdoclink href="CHAR"><span class="TYPE">char</span></gtkdoclink> *filename</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE"><span class="TYPE">xmlSecKeyDataType</span></a> type</code>);</pre> -</div> +<a name="AEN45036"></a><h2>Name</h2>keysstore -- Keys store implementation for MS Crypto.</div> <div class="REFSECT1"> -<a name="XMLSEC-MSCRYPTO-KEYSSTORE.DESCRIPTION"></a><h2>Description</h2> -<p>Keys store implementation for MS Crypto.</p> -</div> -<div class="REFSECT1"> -<a name="XMLSEC-MSCRYPTO-KEYSSTORE.DETAILS"></a><h2>Details</h2> -<div class="REFSECT2"> -<a name="XMLSECMSCRYPTOKEYSSTOREADOPTKEY"></a><h3>xmlSecMSCryptoKeysStoreAdoptKey ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecMSCryptoKeysStoreAdoptKey (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, - <code class="PARAMETER"><a href="xmlsec-keys.html#XMLSECKEY"><span class="TYPE">xmlSecKeyPtr</span></a> key</code>);</pre> -<p>Adds <code class="PARAMETER">key</code> to the <code class="PARAMETER">store</code>.</p> +<a name="XMLSEC-MSCRYPTO-KEYSSTORE.FUNCTIONS"></a><h2>Functions</h2> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN45041"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41483"><span style="white-space: nowrap"><code class="PARAMETER">store</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to MSCrypto keys store.</p></td> +<td><font><span class="RETURNVALUE">xmlSecKeyStoreId</span></font></td> +<td> +<a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTOREGETKLASS">xmlSecMSCryptoKeysStoreGetKlass</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> +</tr> +<tr> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTOREADOPTKEY">xmlSecMSCryptoKeysStoreAdoptKey</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41488"><span style="white-space: nowrap"><code class="PARAMETER">key</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to key.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTORELOAD">xmlSecMSCryptoKeysStoreLoad</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41493"><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> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTORESAVE">xmlSecMSCryptoKeysStoreSave</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> </div> -<hr> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-MSCRYPTO-KEYSSTORE.OTHER"></a><h2>Types and Values</h2> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN45074"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<tbody><tr> +<td>#define</td> +<td><a href="xmlsec-mscrypto-keysstore.html#XMLSECMSCRYPTOKEYSSTOREID">xmlSecMSCryptoKeysStoreId</a></td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-MSCRYPTO-KEYSSTORE.DESCRIPTION"></a><h2>Description</h2> +<p>Keys store implementation for MS Crypto.</p> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-MSCRYPTO-KEYSSTORE.FUNCTIONS_DETAILS"></a><h2>Functions</h2> <div class="REFSECT2"> <a name="XMLSECMSCRYPTOKEYSSTOREGETKLASS"></a><h3>xmlSecMSCryptoKeysStoreGetKlass ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLSECKEYSTOREID"><span class="RETURNVALUE">xmlSecKeyStoreId</span></gtkdoclink> xmlSecMSCryptoKeysStoreGetKlass (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">xmlSecKeyStoreId</span></font> +xmlSecMSCryptoKeysStoreGetKlass (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> <p>The MSCrypto list based keys store klass.</p> -<p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN41509"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>MSCrypto list based keys store klass.</p></td> -</tr></tbody></table> +<div class="REFSECT3"> +<a name="AEN45096"></a><h4>Returns</h4> +<p> MSCrypto list based keys store klass.</p> +</div> </div> <hr> <div class="REFSECT2"> -<a name="XMLSECMSCRYPTOKEYSSTOREID"></a><h3>xmlSecMSCryptoKeysStoreId</h3> -<pre class="PROGRAMLISTING">#define xmlSecMSCryptoKeysStoreId xmlSecMSCryptoKeysStoreGetKlass()</pre> -<p>A MSCrypto keys store klass id.</p> +<a name="XMLSECMSCRYPTOKEYSSTOREADOPTKEY"></a><h3>xmlSecMSCryptoKeysStoreAdoptKey ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecMSCryptoKeysStoreAdoptKey (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, + <code class="PARAMETER"><a href="xmlsec-keys.html#XMLSECKEY"><span class="TYPE">xmlSecKeyPtr</span></a> key</code>);</pre> +<p>Adds <code class="PARAMETER">key</code> + to the <code class="PARAMETER">store</code> +.</p> +<div class="REFSECT3"> +<a name="AEN45115"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN45117"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> +<tr> +<td><p>store</p></td> +<td><p>the pointer to MSCrypto keys store.</p></td> +<td> </td> +</tr> +<tr> +<td><p>key</p></td> +<td><p>the pointer to key.</p></td> +<td> </td> +</tr> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN45132"></a><h4>Returns</h4> +<p> 0 on success or a negative value if an error occurs.</p> +</div> </div> <hr> <div class="REFSECT2"> <a name="XMLSECMSCRYPTOKEYSSTORELOAD"></a><h3>xmlSecMSCryptoKeysStoreLoad ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecMSCryptoKeysStoreLoad (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, - <code class="PARAMETER">const <gtkdoclink href="CHAR"><span class="TYPE">char</span></gtkdoclink> *uri</code>, - <code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> keysMngr</code>);</pre> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecMSCryptoKeysStoreLoad (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, + <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *uri</code>, + <code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSMNGR"><span class="TYPE">xmlSecKeysMngrPtr</span></a> keysMngr</code>);</pre> <p>Reads keys from an XML file.</p> +<div class="REFSECT3"> +<a name="AEN45152"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN41538"><span style="white-space: nowrap"><code class="PARAMETER">store</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to MSCrypto keys store.</p></td> -</tr> +<a name="AEN45154"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41543"><span style="white-space: nowrap"><code class="PARAMETER">uri</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the filename.</p></td> +<td><p>store</p></td> +<td><p>the pointer to MSCrypto keys store.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41548"><span style="white-space: nowrap"><code class="PARAMETER">keysMngr</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to associated keys manager.</p></td> +<td><p>uri</p></td> +<td><p>the filename.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41553"><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> +<td><p>keysMngr</p></td> +<td><p>the pointer to associated keys manager.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN45175"></a><h4>Returns</h4> +<p> 0 on success or a negative value if an error occurs.</p> +</div> </div> <hr> <div class="REFSECT2"> <a name="XMLSECMSCRYPTOKEYSSTORESAVE"></a><h3>xmlSecMSCryptoKeysStoreSave ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecMSCryptoKeysStoreSave (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, - <code class="PARAMETER">const <gtkdoclink href="CHAR"><span class="TYPE">char</span></gtkdoclink> *filename</code>, - <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE"><span class="TYPE">xmlSecKeyDataType</span></a> type</code>);</pre> -<p>Writes keys from <code class="PARAMETER">store</code> to an XML file.</p> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecMSCryptoKeysStoreSave (<code class="PARAMETER"><a href="xmlsec-keysmngr.html#XMLSECKEYSTORE"><span class="TYPE">xmlSecKeyStorePtr</span></a> store</code>, + <code class="PARAMETER">const <font><span class="TYPE">char</span></font> *filename</code>, + <code class="PARAMETER"><a href="xmlsec-keysdata.html#XMLSECKEYDATATYPE"><span class="TYPE">xmlSecKeyDataType</span></a> type</code>);</pre> +<p>Writes keys from <code class="PARAMETER">store</code> + to an XML file.</p> +<div class="REFSECT3"> +<a name="AEN45196"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN45198"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41577"><span style="white-space: nowrap"><code class="PARAMETER">store</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to MSCrypto keys store.</p></td> +<td><p>store</p></td> +<td><p>the pointer to MSCrypto keys store.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41582"><span style="white-space: nowrap"><code class="PARAMETER">filename</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the filename.</p></td> +<td><p>filename</p></td> +<td><p>the filename.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN41587"><span style="white-space: nowrap"><code class="PARAMETER">type</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the saved keys type (public, private, ...).</p></td> +<td><p>type</p></td> +<td><p>the saved keys type (public, private, ...).</p></td> +<td> </td> </tr> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN41592"><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> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN45219"></a><h4>Returns</h4> +<p> 0 on success or a negative value if an error occurs.</p> +</div> +</div> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-MSCRYPTO-KEYSSTORE.OTHER_DETAILS"></a><h2>Types and Values</h2> +<div class="REFSECT2"> +<a name="XMLSECMSCRYPTOKEYSSTOREID"></a><h3>xmlSecMSCryptoKeysStoreId</h3> +<pre class="PROGRAMLISTING">#define xmlSecMSCryptoKeysStoreId xmlSecMSCryptoKeysStoreGetKlass()</pre> +<p>A MSCrypto keys store klass id.</p> </div> </div> <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle"> |