diff options
Diffstat (limited to 'docs/api/xmlsec-bn.html')
| -rw-r--r-- | docs/api/xmlsec-bn.html | 1340 |
1 files changed, 926 insertions, 414 deletions
diff --git a/docs/api/xmlsec-bn.html b/docs/api/xmlsec-bn.html index 1b68b19b..d863fd3a 100644 --- a/docs/api/xmlsec-bn.html +++ b/docs/api/xmlsec-bn.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,622 +101,1111 @@ </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-base64.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> +<td><a accesskey="p" href="xmlsec-base64.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="xmlsec-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-buffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="xmlsec-buffer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <h1> <a name="XMLSEC-BN"></a>bn</h1> <div class="REFNAMEDIV"> -<a name="AEN3539"></a><h2>Name</h2>bn -- Big numbers support functions.</div> -<div class="REFSYNOPSISDIV"> -<a name="XMLSEC-BN.SYNOPSIS"></a><h2>Synopsis</h2> -<pre class="SYNOPSIS"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNADD">xmlSecBnAdd</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> delta</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNBLOBSETNODEVALUE">xmlSecBnBlobSetNodeValue</a> (<code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>, - <code class="PARAMETER"><gtkdoclink href="XMLNODE"><span class="TYPE">xmlNodePtr</span></gtkdoclink> cur</code>, - <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> reverse</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> addLineBreaks</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNCOMPARE">xmlSecBnCompare</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNCOMPAREREVERSE">xmlSecBnCompareReverse</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>); -<gtkdoclink href="XMLSECBN"><span class="RETURNVALUE">xmlSecBnPtr</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNCREATE">xmlSecBnCreate</a> (<code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>); -<gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNDESTROY">xmlSecBnDestroy</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNDIV">xmlSecBnDiv</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> divider</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> *mod</code>); -<gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNFINALIZE">xmlSecBnFinalize</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>); -enum <a href="xmlsec-bn.html#XMLSECBNFORMAT">xmlSecBnFormat</a>; -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNFROMDECSTRING">xmlSecBnFromDecString</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *str</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNFROMHEXSTRING">xmlSecBnFromHexString</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *str</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNFROMSTRING">xmlSecBnFromString</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *str</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> base</code>); -<a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="RETURNVALUE">xmlSecByte</span></a> * <a href="xmlsec-bn.html#XMLSECBNGETDATA">xmlSecBnGetData</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNGETNODEVALUE">xmlSecBnGetNodeValue</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="XMLNODE"><span class="TYPE">xmlNodePtr</span></gtkdoclink> cur</code>, - <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> reverse</code>); -<a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="RETURNVALUE">xmlSecSize</span></a> <a href="xmlsec-bn.html#XMLSECBNGETSIZE">xmlSecBnGetSize</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNINITIALIZE">xmlSecBnInitialize</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNMUL">xmlSecBnMul</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> multiplier</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNREVERSE">xmlSecBnReverse</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNSETDATA">xmlSecBnSetData</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNSETNODEVALUE">xmlSecBnSetNodeValue</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="XMLNODE"><span class="TYPE">xmlNodePtr</span></gtkdoclink> cur</code>, - <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> reverse</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> addLineBreaks</code>); -<gtkdoclink href="XMLCHAR"><span class="RETURNVALUE">xmlChar</span></gtkdoclink> * <a href="xmlsec-bn.html#XMLSECBNTODECSTRING">xmlSecBnToDecString</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>); -<gtkdoclink href="XMLCHAR"><span class="RETURNVALUE">xmlChar</span></gtkdoclink> * <a href="xmlsec-bn.html#XMLSECBNTOHEXSTRING">xmlSecBnToHexString</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>); -<gtkdoclink href="XMLCHAR"><span class="RETURNVALUE">xmlChar</span></gtkdoclink> * <a href="xmlsec-bn.html#XMLSECBNTOSTRING">xmlSecBnToString</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> base</code>); -<gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink><a href="xmlsec-bn.html#XMLSECBNZERO">xmlSecBnZero</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -</div> -<div class="REFSECT1"> -<a name="XMLSEC-BN.DESCRIPTION"></a><h2>Description</h2> -<p>Big numbers support functions.</p> -</div> +<a name="AEN4018"></a><h2>Name</h2>bn -- Big numbers support functions.</div> <div class="REFSECT1"> -<a name="XMLSEC-BN.DETAILS"></a><h2>Details</h2> -<div class="REFSECT2"> -<a name="XMLSECBNADD"></a><h3>xmlSecBnAdd ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnAdd (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> delta</code>);</pre> -<p>Adds <code class="PARAMETER">delta</code> to <code class="PARAMETER">bn</code>.</p> +<a name="XMLSEC-BN.FUNCTIONS"></a><h2>Functions</h2> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4023"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<tbody> +<tr> +<td><font><span class="RETURNVALUE">xmlSecBnPtr</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNCREATE">xmlSecBnCreate</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> +</tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3790"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><font><span class="RETURNVALUE">void</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNDESTROY">xmlSecBnDestroy</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3795"><span style="white-space: nowrap"><code class="PARAMETER">delta</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the delta.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNINITIALIZE">xmlSecBnInitialize</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3800"><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">void</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNFINALIZE">xmlSecBnFinalize</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> -</tbody></table> -</div> -<hr> -<div class="REFSECT2"> -<a name="XMLSECBNBLOBSETNODEVALUE"></a><h3>xmlSecBnBlobSetNodeValue ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnBlobSetNodeValue (<code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>, - <code class="PARAMETER"><gtkdoclink href="XMLNODE"><span class="TYPE">xmlNodePtr</span></gtkdoclink> cur</code>, - <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> reverse</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> addLineBreaks</code>);</pre> -<p>Converts the <code class="PARAMETER">blob</code> and sets it to node content.</p> -<p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3833"><span style="white-space: nowrap"><code class="PARAMETER">data</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN blob.</p></td> +<td> +<a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="RETURNVALUE">xmlSecByte</span></a> *</td> +<td> +<a href="xmlsec-bn.html#XMLSECBNGETDATA">xmlSecBnGetData</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3838"><span style="white-space: nowrap"><code class="PARAMETER">dataSize</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the size of BN blob.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNSETDATA">xmlSecBnSetData</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3843"><span style="white-space: nowrap"><code class="PARAMETER">cur</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the poitner to an XML node.</p></td> +<td><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="RETURNVALUE">xmlSecSize</span></a></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNGETSIZE">xmlSecBnGetSize</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3848"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the BN format.</p></td> +<td><font><span class="RETURNVALUE">void</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNZERO">xmlSecBnZero</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3853"><span style="white-space: nowrap"><code class="PARAMETER">reverse</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the flag that indicates whether to reverse the buffer before writing.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNFROMSTRING">xmlSecBnFromString</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3858"><span style="white-space: nowrap"><code class="PARAMETER">addLineBreaks</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>if the flag is equal to 1 then -linebreaks will be added before and after -new buffer content.</p></td> +<td> +<font><span class="RETURNVALUE">xmlChar</span></font> *</td> +<td> +<a href="xmlsec-bn.html#XMLSECBNTOSTRING">xmlSecBnToString</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3863"><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 and a negative values if an error occurs.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNFROMHEXSTRING">xmlSecBnFromHexString</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> -</tbody></table> -</div> -<hr> -<div class="REFSECT2"> -<a name="XMLSECBNCOMPARE"></a><h3>xmlSecBnCompare ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnCompare (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>);</pre> -<p>Compares the <code class="PARAMETER">bn</code> with <code class="PARAMETER">data</code>.</p> -<p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3888"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td> +<font><span class="RETURNVALUE">xmlChar</span></font> *</td> +<td> +<a href="xmlsec-bn.html#XMLSECBNTOHEXSTRING">xmlSecBnToHexString</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3893"><span style="white-space: nowrap"><code class="PARAMETER">data</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the data to compare BN to.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNFROMDECSTRING">xmlSecBnFromDecString</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3898"><span style="white-space: nowrap"><code class="PARAMETER">dataSize</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the <code class="PARAMETER">data</code> size.</p></td> +<td> +<font><span class="RETURNVALUE">xmlChar</span></font> *</td> +<td> +<a href="xmlsec-bn.html#XMLSECBNTODECSTRING">xmlSecBnToDecString</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3904"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>0 if data is equal, negative value if <code class="PARAMETER">bn</code> is less or positive value if <code class="PARAMETER">bn</code> -is greater than <code class="PARAMETER">data</code>.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNMUL">xmlSecBnMul</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-bn.html#XMLSECBNDIV">xmlSecBnDiv</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> -</tbody></table> -</div> -<hr> -<div class="REFSECT2"> -<a name="XMLSECBNCOMPAREREVERSE"></a><h3>xmlSecBnCompareReverse ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnCompareReverse (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>);</pre> -<p>Compares the <code class="PARAMETER">bn</code> with reverse <code class="PARAMETER">data</code>.</p> -<p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3932"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNADD">xmlSecBnAdd</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-bn.html#XMLSECBNREVERSE">xmlSecBnReverse</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-bn.html#XMLSECBNCOMPARE">xmlSecBnCompare</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3937"><span style="white-space: nowrap"><code class="PARAMETER">data</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the data to compare BN to.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNCOMPAREREVERSE">xmlSecBnCompareReverse</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3942"><span style="white-space: nowrap"><code class="PARAMETER">dataSize</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the <code class="PARAMETER">data</code> size.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNGETNODEVALUE">xmlSecBnGetNodeValue</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3948"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>0 if data is equal, negative value if <code class="PARAMETER">bn</code> is less or positive value if <code class="PARAMETER">bn</code> -is greater than <code class="PARAMETER">data</code>.</p></td> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNSETNODEVALUE">xmlSecBnSetNodeValue</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> </tr> -</tbody></table> +<tr> +<td><font><span class="RETURNVALUE">int</span></font></td> +<td> +<a href="xmlsec-bn.html#XMLSECBNBLOBSETNODEVALUE">xmlSecBnBlobSetNodeValue</a> <span class="c_punctuation"><span class="PHRASE">()</span></span> +</td> +</tr> +</tbody> +</table> +<p></p> </div> -<hr> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-BN.OTHER"></a><h2>Types and Values</h2> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4189"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<tbody><tr> +<td>enum</td> +<td><a href="xmlsec-bn.html#XMLSECBNFORMAT">xmlSecBnFormat</a></td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-BN.DESCRIPTION"></a><h2>Description</h2> +<p>Big numbers support functions.</p> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-BN.FUNCTIONS_DETAILS"></a><h2>Functions</h2> <div class="REFSECT2"> <a name="XMLSECBNCREATE"></a><h3>xmlSecBnCreate ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLSECBN"><span class="RETURNVALUE">xmlSecBnPtr</span></gtkdoclink> xmlSecBnCreate (<code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>);</pre> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">xmlSecBnPtr</span></font> +xmlSecBnCreate (<code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>);</pre> <p>Creates a new BN object. Caller is responsible for destroying it -by calling <code class="PARAMETER">xmlSecBnDestroy</code> function.</p> +by calling <code class="PARAMETER">xmlSecBnDestroy</code> + function.</p> +<div class="REFSECT3"> +<a name="AEN4213"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4215"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>size</p></td> +<td><p>the initial allocated BN size.</p></td> +<td> </td> +</tr></tbody> +</table> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN3969"><span style="white-space: nowrap"><code class="PARAMETER">size</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the initial allocated BN size.</p></td> -</tr> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN3974"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the newly BN or a NULL if an error occurs.</p></td> -</tr> -</tbody></table> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4224"></a><h4>Returns</h4> +<p> the newly BN or a NULL if an error occurs.</p> +</div> </div> <hr> <div class="REFSECT2"> <a name="XMLSECBNDESTROY"></a><h3>xmlSecBnDestroy ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink> xmlSecBnDestroy (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -<p>Destroys <code class="PARAMETER">bn</code> object created with <code class="PARAMETER">xmlSecBnCreate</code> function.</p> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">void</span></font> +xmlSecBnDestroy (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>);</pre> +<p>Destroys <code class="PARAMETER">bn</code> + object created with <code class="PARAMETER">xmlSecBnCreate</code> + function.</p> +<div class="REFSECT3"> +<a name="AEN4240"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4242"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> +</tr></tbody> +</table> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN3993"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> -</tr></tbody></table> +</div> +</div> </div> <hr> <div class="REFSECT2"> -<a name="XMLSECBNDIV"></a><h3>xmlSecBnDiv ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnDiv (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> divider</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> *mod</code>);</pre> -<p>Divides <code class="PARAMETER">bn</code> by <code class="PARAMETER">divider</code> and places modulus into <code class="PARAMETER">mod</code>.</p> +<a name="XMLSECBNINITIALIZE"></a><h3>xmlSecBnInitialize ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnInitialize (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>);</pre> +<p>Initializes a BN object. Caller is responsible for destroying it +by calling <code class="PARAMETER">xmlSecBnFinalize</code> + function.</p> +<div class="REFSECT3"> +<a name="AEN4266"></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="AEN4019"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> -</tr> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN4024"><span style="white-space: nowrap"><code class="PARAMETER">divider</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the divider</p></td> -</tr> +<a name="AEN4268"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4029"><span style="white-space: nowrap"><code class="PARAMETER">mod</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer for modulus result.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4034"><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>size</p></td> +<td><p>the initial allocated BN size.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4283"></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="XMLSECBNFINALIZE"></a><h3>xmlSecBnFinalize ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink> xmlSecBnFinalize (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -<p>Destroys <code class="PARAMETER">bn</code> object created with <code class="PARAMETER">xmlSecBnInitialize</code> function.</p> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">void</span></font> +xmlSecBnFinalize (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>);</pre> +<p>Destroys <code class="PARAMETER">bn</code> + object created with <code class="PARAMETER">xmlSecBnInitialize</code> + function.</p> +<div class="REFSECT3"> +<a name="AEN4299"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4301"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECBNGETDATA"></a><h3>xmlSecBnGetData ()</h3> +<pre class="PROGRAMLISTING"><a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="RETURNVALUE">xmlSecByte</span></a> * +xmlSecBnGetData (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>);</pre> +<p>Gets pointer to the binary <code class="PARAMETER">bn</code> + representation.</p> +<div class="REFSECT3"> +<a name="AEN4322"></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="AEN4053"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> -</tr></tbody></table> +<a name="AEN4324"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4333"></a><h4>Returns</h4> +<p> pointer to binary BN data or NULL if an error occurs.</p> +</div> </div> <hr> <div class="REFSECT2"> -<a name="XMLSECBNFORMAT"></a><h3>enum xmlSecBnFormat</h3> -<pre class="PROGRAMLISTING">typedef enum { - xmlSecBnBase64, - xmlSecBnHex, - xmlSecBnDec -} xmlSecBnFormat;</pre> -<p>The big numbers formats.</p> +<a name="XMLSECBNSETDATA"></a><h3>xmlSecBnSetData ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnSetData (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>);</pre> +<p>Sets the value of <code class="PARAMETER">bn</code> + to <code class="PARAMETER">data</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4355"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4357"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="XMLSECBNBASE64"><span style="white-space: nowrap"><tt class="LITERAL">xmlSecBnBase64</tt></span></a></td> -<td align="LEFT" valign="TOP"><p>the base64 decoded binary blob.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="XMLSECBNHEX"><span style="white-space: nowrap"><tt class="LITERAL">xmlSecBnHex</tt></span></a></td> -<td align="LEFT" valign="TOP"><p>the hex number.</p></td> +<td><p>data</p></td> +<td><p>the pointer to new BN binary data.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="XMLSECBNDEC"><span style="white-space: nowrap"><tt class="LITERAL">xmlSecBnDec</tt></span></a></td> -<td align="LEFT" valign="TOP"><p>the decimal number.</p></td> +<td><p>size</p></td> +<td><p>the size of new BN data.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4378"></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="XMLSECBNFROMDECSTRING"></a><h3>xmlSecBnFromDecString ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnFromDecString (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *str</code>);</pre> -<p>Reads <code class="PARAMETER">bn</code> from decimal string <code class="PARAMETER">str</code>.</p> +<a name="XMLSECBNGETSIZE"></a><h3>xmlSecBnGetSize ()</h3> +<pre class="PROGRAMLISTING"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="RETURNVALUE">xmlSecSize</span></a> +xmlSecBnGetSize (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>);</pre> +<p>Gets the size of binary data in <code class="PARAMETER">bn</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4393"></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="AEN4097"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> -</tr> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN4102"><span style="white-space: nowrap"><code class="PARAMETER">str</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the string with BN.</p></td> -</tr> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN4107"><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> +<a name="AEN4395"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4404"></a><h4>Returns</h4> +<p> the size of binary data.</p> +</div> </div> <hr> <div class="REFSECT2"> -<a name="XMLSECBNFROMHEXSTRING"></a><h3>xmlSecBnFromHexString ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnFromHexString (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *str</code>);</pre> -<p>Reads <code class="PARAMETER">bn</code> from hex string <code class="PARAMETER">str</code>.</p> +<a name="XMLSECBNZERO"></a><h3>xmlSecBnZero ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">void</span></font> +xmlSecBnZero (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>);</pre> +<p>Sets the value of <code class="PARAMETER">bn</code> + to zero.</p> +<div class="REFSECT3"> +<a name="AEN4419"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4421"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECBNFROMSTRING"></a><h3>xmlSecBnFromString ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnFromString (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER">const <font><span class="TYPE">xmlChar</span></font> *str</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> base</code>);</pre> +<p>Reads <code class="PARAMETER">bn</code> + from string <code class="PARAMETER">str</code> + assuming it has base <code class="PARAMETER">base</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4450"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4452"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4129"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4134"><span style="white-space: nowrap"><code class="PARAMETER">str</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the string with BN.</p></td> +<td><p>str</p></td> +<td><p>the string with BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4139"><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>base</p></td> +<td><p>the base for <code class="PARAMETER">str</code> +.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4474"></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="XMLSECBNFROMSTRING"></a><h3>xmlSecBnFromString ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnFromString (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *str</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> base</code>);</pre> -<p>Reads <code class="PARAMETER">bn</code> from string <code class="PARAMETER">str</code> assuming it has base <code class="PARAMETER">base</code>.</p> +<a name="XMLSECBNTOSTRING"></a><h3>xmlSecBnToString ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">xmlChar</span></font> * +xmlSecBnToString (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> base</code>);</pre> +<p>Writes <code class="PARAMETER">bn</code> + to string with base <code class="PARAMETER">base</code> +. Caller is responsible for +freeing returned string with <code class="PARAMETER">xmlFree</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4494"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4496"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4165"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4170"><span style="white-space: nowrap"><code class="PARAMETER">str</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the string with BN.</p></td> +<td><p>base</p></td> +<td><p>the base for returned string.</p></td> +<td> </td> </tr> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4511"></a><h4>Returns</h4> +<p> the string represenataion if BN or a NULL if an error occurs.</p> +</div> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECBNFROMHEXSTRING"></a><h3>xmlSecBnFromHexString ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnFromHexString (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER">const <font><span class="TYPE">xmlChar</span></font> *str</code>);</pre> +<p>Reads <code class="PARAMETER">bn</code> + from hex string <code class="PARAMETER">str</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4530"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4532"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4175"><span style="white-space: nowrap"><code class="PARAMETER">base</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the base for <code class="PARAMETER">str</code>.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4181"><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>str</p></td> +<td><p>the string with BN.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4547"></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="XMLSECBNGETDATA"></a><h3>xmlSecBnGetData ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="RETURNVALUE">xmlSecByte</span></a> * xmlSecBnGetData (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -<p>Gets pointer to the binary <code class="PARAMETER">bn</code> representation.</p> +<a name="XMLSECBNTOHEXSTRING"></a><h3>xmlSecBnToHexString ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">xmlChar</span></font> * +xmlSecBnToHexString (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>);</pre> +<p>Writes <code class="PARAMETER">bn</code> + to hex string. Caller is responsible for +freeing returned string with <code class="PARAMETER">xmlFree</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4563"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4565"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4574"></a><h4>Returns</h4> +<p> the string represenataion if BN or a NULL if an error occurs.</p> +</div> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECBNFROMDECSTRING"></a><h3>xmlSecBnFromDecString ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnFromDecString (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER">const <font><span class="TYPE">xmlChar</span></font> *str</code>);</pre> +<p>Reads <code class="PARAMETER">bn</code> + from decimal string <code class="PARAMETER">str</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4593"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4595"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4199"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4204"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>pointer to binary BN data or NULL if an error occurs.</p></td> +<td><p>str</p></td> +<td><p>the string with BN.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4610"></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="XMLSECBNGETNODEVALUE"></a><h3>xmlSecBnGetNodeValue ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnGetNodeValue (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="XMLNODE"><span class="TYPE">xmlNodePtr</span></gtkdoclink> cur</code>, - <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> reverse</code>);</pre> -<p>Converts the node content from <code class="PARAMETER">format</code> to <code class="PARAMETER">bn</code>.</p> +<a name="XMLSECBNTODECSTRING"></a><h3>xmlSecBnToDecString ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">xmlChar</span></font> * +xmlSecBnToDecString (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>);</pre> +<p>Writes <code class="PARAMETER">bn</code> + to decimal string. Caller is responsible for +freeing returned string with <code class="PARAMETER">xmlFree</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4626"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4628"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4637"></a><h4>Returns</h4> +<p> the string represenataion if BN or a NULL if an error occurs.</p> +</div> +</div> +<hr> +<div class="REFSECT2"> +<a name="XMLSECBNMUL"></a><h3>xmlSecBnMul ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnMul (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> multiplier</code>);</pre> +<p>Multiplies <code class="PARAMETER">bn</code> + with <code class="PARAMETER">multiplier</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4656"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4658"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4232"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4237"><span style="white-space: nowrap"><code class="PARAMETER">cur</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the poitner to an XML node.</p></td> +<td><p>multiplier</p></td> +<td><p>the multiplier.</p></td> +<td> </td> </tr> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4673"></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="XMLSECBNDIV"></a><h3>xmlSecBnDiv ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnDiv (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> divider</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> *mod</code>);</pre> +<p>Divides <code class="PARAMETER">bn</code> + by <code class="PARAMETER">divider</code> + and places modulus into <code class="PARAMETER">mod</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4696"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> +<p></p> +<a name="AEN4698"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4242"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the BN format.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4247"><span style="white-space: nowrap"><code class="PARAMETER">reverse</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>if set then reverse read buffer after reading.</p></td> +<td><p>divider</p></td> +<td><p>the divider</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4252"><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 and a negative values if an error occurs.</p></td> +<td><p>mod</p></td> +<td><p>the pointer for modulus result.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4719"></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="XMLSECBNGETSIZE"></a><h3>xmlSecBnGetSize ()</h3> -<pre class="PROGRAMLISTING"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="RETURNVALUE">xmlSecSize</span></a> xmlSecBnGetSize (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -<p>Gets the size of binary data in <code class="PARAMETER">bn</code>.</p> +<a name="XMLSECBNADD"></a><h3>xmlSecBnAdd ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnAdd (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> delta</code>);</pre> +<p>Adds <code class="PARAMETER">delta</code> + to <code class="PARAMETER">bn</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4738"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4740"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4270"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4275"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the size of binary data.</p></td> +<td><p>delta</p></td> +<td><p>the delta.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4755"></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="XMLSECBNINITIALIZE"></a><h3>xmlSecBnInitialize ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnInitialize (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>);</pre> -<p>Initializes a BN object. Caller is responsible for destroying it -by calling <code class="PARAMETER">xmlSecBnFinalize</code> function.</p> +<a name="XMLSECBNREVERSE"></a><h3>xmlSecBnReverse ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnReverse (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>);</pre> +<p>Reverses bytes order in <code class="PARAMETER">bn</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4770"></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="AEN4296"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> -</tr> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN4301"><span style="white-space: nowrap"><code class="PARAMETER">size</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the initial allocated BN size.</p></td> -</tr> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN4306"><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> +<a name="AEN4772"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody><tr> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> +</tr></tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4781"></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="XMLSECBNMUL"></a><h3>xmlSecBnMul ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnMul (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> multiplier</code>);</pre> -<p>Multiplies <code class="PARAMETER">bn</code> with <code class="PARAMETER">multiplier</code>.</p> +<a name="XMLSECBNCOMPARE"></a><h3>xmlSecBnCompare ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnCompare (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>);</pre> +<p>Compares the <code class="PARAMETER">bn</code> + with <code class="PARAMETER">data</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4803"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4805"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4328"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4333"><span style="white-space: nowrap"><code class="PARAMETER">multiplier</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the multiplier.</p></td> +<td><p>data</p></td> +<td><p>the data to compare BN to.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4338"><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>dataSize</p></td> +<td><p>the <code class="PARAMETER">data</code> +size.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4827"></a><h4>Returns</h4> +<p> 0 if data is equal, negative value if <code class="PARAMETER">bn</code> +is less or positive value if <code class="PARAMETER">bn</code> +is greater than <code class="PARAMETER">data</code> +.</p> +</div> </div> <hr> <div class="REFSECT2"> -<a name="XMLSECBNREVERSE"></a><h3>xmlSecBnReverse ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnReverse (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -<p>Reverses bytes order in <code class="PARAMETER">bn</code>.</p> +<a name="XMLSECBNCOMPAREREVERSE"></a><h3>xmlSecBnCompareReverse ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnCompareReverse (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>);</pre> +<p>Compares the <code class="PARAMETER">bn</code> + with reverse <code class="PARAMETER">data</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4852"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4854"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4356"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4361"><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>data</p></td> +<td><p>the data to compare BN to.</p></td> +<td> </td> </tr> -</tbody></table> +<tr> +<td><p>dataSize</p></td> +<td><p>the <code class="PARAMETER">data</code> +size.</p></td> +<td> </td> +</tr> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4876"></a><h4>Returns</h4> +<p> 0 if data is equal, negative value if <code class="PARAMETER">bn</code> +is less or positive value if <code class="PARAMETER">bn</code> +is greater than <code class="PARAMETER">data</code> +.</p> +</div> </div> <hr> <div class="REFSECT2"> -<a name="XMLSECBNSETDATA"></a><h3>xmlSecBnSetData ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnSetData (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> size</code>);</pre> -<p>Sets the value of <code class="PARAMETER">bn</code> to <code class="PARAMETER">data</code>.</p> +<a name="XMLSECBNGETNODEVALUE"></a><h3>xmlSecBnGetNodeValue ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnGetNodeValue (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> cur</code>, + <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> reverse</code>);</pre> +<p>Converts the node content from <code class="PARAMETER">format</code> + to <code class="PARAMETER">bn</code> +.</p> +<div class="REFSECT3"> +<a name="AEN4904"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4906"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4386"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4391"><span style="white-space: nowrap"><code class="PARAMETER">data</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to new BN binary data.</p></td> +<td><p>cur</p></td> +<td><p>the poitner to an XML node.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4396"><span style="white-space: nowrap"><code class="PARAMETER">size</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the size of new BN data.</p></td> +<td><p>format</p></td> +<td><p>the BN format.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4401"><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>reverse</p></td> +<td><p>if set then reverse read buffer after reading.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4933"></a><h4>Returns</h4> +<p> 0 on success and a negative values if an error occurs.</p> +</div> </div> <hr> <div class="REFSECT2"> <a name="XMLSECBNSETNODEVALUE"></a><h3>xmlSecBnSetNodeValue ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBnSetNodeValue (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><gtkdoclink href="XMLNODE"><span class="TYPE">xmlNodePtr</span></gtkdoclink> cur</code>, - <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> reverse</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> addLineBreaks</code>);</pre> -<p>Converts the <code class="PARAMETER">bn</code> and sets it to node content.</p> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnSetNodeValue (<code class="PARAMETER"><font><span class="TYPE">xmlSecBnPtr</span></font> bn</code>, + <code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> cur</code>, + <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> reverse</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> addLineBreaks</code>);</pre> +<p>Converts the <code class="PARAMETER">bn</code> + and sets it to node content.</p> +<div class="REFSECT3"> +<a name="AEN4960"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN4962"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4431"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>bn</p></td> +<td><p>the pointer to BN.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4436"><span style="white-space: nowrap"><code class="PARAMETER">cur</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the poitner to an XML node.</p></td> +<td><p>cur</p></td> +<td><p>the poitner to an XML node.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4441"><span style="white-space: nowrap"><code class="PARAMETER">format</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the BN format.</p></td> +<td><p>format</p></td> +<td><p>the BN format.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4446"><span style="white-space: nowrap"><code class="PARAMETER">reverse</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the flag that indicates whether to reverse the buffer before writing.</p></td> +<td><p>reverse</p></td> +<td><p>the flag that indicates whether to reverse the buffer before writing.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4451"><span style="white-space: nowrap"><code class="PARAMETER">addLineBreaks</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the flag; it is equal to 1 then linebreaks will be added before and after new buffer content.</p></td> +<td><p>addLineBreaks</p></td> +<td><p>the flag; it is equal to 1 then linebreaks will be added before and after new buffer content.</p></td> +<td> </td> </tr> -<tr> -<td align="LEFT" valign="TOP"><a name="AEN4456"><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 and a negative values if an error occurs.</p></td> -</tr> -</tbody></table> +</tbody> +</table> +<p></p> +</div> +</div> +<div class="REFSECT3"> +<a name="AEN4995"></a><h4>Returns</h4> +<p> 0 on success and a negative values if an error occurs.</p> +</div> </div> <hr> <div class="REFSECT2"> -<a name="XMLSECBNTODECSTRING"></a><h3>xmlSecBnToDecString ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLCHAR"><span class="RETURNVALUE">xmlChar</span></gtkdoclink> * xmlSecBnToDecString (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -<p>Writes <code class="PARAMETER">bn</code> to decimal string. Caller is responsible for -freeing returned string with <code class="PARAMETER">xmlFree</code>.</p> +<a name="XMLSECBNBLOBSETNODEVALUE"></a><h3>xmlSecBnBlobSetNodeValue ()</h3> +<pre class="PROGRAMLISTING"><font><span class="RETURNVALUE">int</span></font> +xmlSecBnBlobSetNodeValue (<code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *data</code>, + <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> dataSize</code>, + <code class="PARAMETER"><font><span class="TYPE">xmlNodePtr</span></font> cur</code>, + <code class="PARAMETER"><a href="xmlsec-bn.html#XMLSECBNFORMAT"><span class="TYPE">xmlSecBnFormat</span></a> format</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> reverse</code>, + <code class="PARAMETER"><font><span class="TYPE">int</span></font> addLineBreaks</code>);</pre> +<p>Converts the <code class="PARAMETER">blob</code> + and sets it to node content.</p> +<div class="REFSECT3"> +<a name="AEN5025"></a><h4>Parameters</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN5027"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4475"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>data</p></td> +<td><p>the pointer to BN blob.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4480"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the string represenataion if BN or a NULL if an error occurs.</p></td> +<td><p>dataSize</p></td> +<td><p>the size of BN blob.</p></td> +<td> </td> </tr> -</tbody></table> -</div> -<hr> -<div class="REFSECT2"> -<a name="XMLSECBNTOHEXSTRING"></a><h3>xmlSecBnToHexString ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLCHAR"><span class="RETURNVALUE">xmlChar</span></gtkdoclink> * xmlSecBnToHexString (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -<p>Writes <code class="PARAMETER">bn</code> to hex string. Caller is responsible for -freeing returned string with <code class="PARAMETER">xmlFree</code>.</p> -<p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4499"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>cur</p></td> +<td><p>the poitner to an XML node.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4504"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the string represenataion if BN or a NULL if an error occurs.</p></td> +<td><p>format</p></td> +<td><p>the BN format.</p></td> +<td> </td> +</tr> +<tr> +<td><p>reverse</p></td> +<td><p>the flag that indicates whether to reverse the buffer before writing.</p></td> +<td> </td> +</tr> +<tr> +<td><p>addLineBreaks</p></td> +<td><p>if the flag is equal to 1 then +linebreaks will be added before and after +new buffer content.</p></td> +<td> </td> </tr> -</tbody></table> +</tbody> +</table> +<p></p> </div> -<hr> +</div> +<div class="REFSECT3"> +<a name="AEN5066"></a><h4>Returns</h4> +<p> 0 on success and a negative values if an error occurs.</p> +</div> +</div> +</div> +<div class="REFSECT1"> +<a name="XMLSEC-BN.OTHER_DETAILS"></a><h2>Types and Values</h2> <div class="REFSECT2"> -<a name="XMLSECBNTOSTRING"></a><h3>xmlSecBnToString ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLCHAR"><span class="RETURNVALUE">xmlChar</span></gtkdoclink> * xmlSecBnToString (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> base</code>);</pre> -<p>Writes <code class="PARAMETER">bn</code> to string with base <code class="PARAMETER">base</code>. Caller is responsible for -freeing returned string with <code class="PARAMETER">xmlFree</code>.</p> +<a name="XMLSECBNFORMAT"></a><h3>enum xmlSecBnFormat</h3> +<p>The big numbers formats.</p> +<div class="REFSECT3"> +<a name="AEN5076"></a><h4>Members</h4> +<div class="INFORMALTABLE"> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> +<a name="AEN5078"></a><table border="0" frame="void" width="100%" class="CALSTABLE"> +<col> +<col> +<col> +<tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4527"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> +<td><p>xmlSecBnBase64</p></td> +<td><p>the base64 decoded binary blob.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4532"><span style="white-space: nowrap"><code class="PARAMETER">base</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the base for returned string.</p></td> +<td><p>xmlSecBnHex</p></td> +<td><p>the hex number.</p></td> +<td> </td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN4537"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the string represenataion if BN or a NULL if an error occurs.</p></td> +<td><p>xmlSecBnDec</p></td> +<td><p>the decimal number.</p></td> +<td> </td> </tr> -</tbody></table> -</div> -<hr> -<div class="REFSECT2"> -<a name="XMLSECBNZERO"></a><h3>xmlSecBnZero ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink> xmlSecBnZero (<code class="PARAMETER"><gtkdoclink href="XMLSECBN"><span class="TYPE">xmlSecBnPtr</span></gtkdoclink> bn</code>);</pre> -<p>Sets the value of <code class="PARAMETER">bn</code> to zero.</p> +</tbody> +</table> <p></p> -<table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN4555"><span style="white-space: nowrap"><code class="PARAMETER">bn</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to BN.</p></td> -</tr></tbody></table> +</div> +</div> </div> </div> <table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="2"><tr valign="middle"> |