diff options
Diffstat (limited to 'docs/api/xmlsec-base64.html')
| -rw-r--r-- | docs/api/xmlsec-base64.html | 225 |
1 files changed, 118 insertions, 107 deletions
diff --git a/docs/api/xmlsec-base64.html b/docs/api/xmlsec-base64.html index c755f3c3..d63cac1f 100644 --- a/docs/api/xmlsec-base64.html +++ b/docs/api/xmlsec-base64.html @@ -87,33 +87,33 @@ <h1> <a name="XMLSEC-BASE64"></a>base64</h1> <div class="REFNAMEDIV"> -<a name="AEN2904"></a><h2>Name</h2>base64 -- Base64 encoding/decoding functions.</div> +<a name="AEN2514"></a><h2>Name</h2>base64 -- Base64 encoding/decoding functions.</div> <div class="REFSYNOPSISDIV"> <a name="XMLSEC-BASE64.SYNOPSIS"></a><h2>Synopsis</h2> -<pre class="SYNOPSIS">#define <a href="xmlsec-base64.html#XMLSEC-BASE64-LINESIZE:CAPS">XMLSEC_BASE64_LINESIZE</a> -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64GETDEFAULTLINESIZE">xmlSecBase64GetDefaultLineSize</a> (<code class="PARAMETER"><span class="TYPE">void</span></code>); -<gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64SETDEFAULTLINESIZE">xmlSecBase64SetDefaultLineSize</a> (<code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> columns</code>); -<gtkdoclink href="XMLSECBASE64CTX"><span class="RETURNVALUE">xmlSecBase64CtxPtr</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64CTXCREATE">xmlSecBase64CtxCreate</a> (<code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> encode</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> columns</code>); -<gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64CTXDESTROY">xmlSecBase64CtxDestroy</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64CTXINITIALIZE">xmlSecBase64CtxInitialize</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> encode</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> columns</code>); -<gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64CTXFINALIZE">xmlSecBase64CtxFinalize</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64CTXUPDATE">xmlSecBase64CtxUpdate</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *in</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> inSize</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *out</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> outSize</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64CTXFINAL">xmlSecBase64CtxFinal</a> (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *out</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> outSize</code>); -<gtkdoclink href="XMLCHAR"><span class="RETURNVALUE">xmlChar</span></gtkdoclink>* <a href="xmlsec-base64.html#XMLSECBASE64ENCODE">xmlSecBase64Encode</a> (<code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *buf</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> len</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> columns</code>); -<gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink><a href="xmlsec-base64.html#XMLSECBASE64DECODE">xmlSecBase64Decode</a> (<code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *str</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *buf</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> len</code>);</pre> +<pre class="SYNOPSIS">#define <a href="xmlsec-base64.html#XMLSEC-BASE64-LINESIZE--CAPS">XMLSEC_BASE64_LINESIZE</a> +<font>int</font> <a href="xmlsec-base64.html#XMLSECBASE64GETDEFAULTLINESIZE">xmlSecBase64GetDefaultLineSize</a> (void); +<font>void</font> <a href="xmlsec-base64.html#XMLSECBASE64SETDEFAULTLINESIZE">xmlSecBase64SetDefaultLineSize</a> (<font>int</font> columns); +<font>xmlSecBase64CtxPtr</font> <a href="xmlsec-base64.html#XMLSECBASE64CTXCREATE">xmlSecBase64CtxCreate</a> (<font>int</font> encode, + <font>int</font> columns); +<font>void</font> <a href="xmlsec-base64.html#XMLSECBASE64CTXDESTROY">xmlSecBase64CtxDestroy</a> (<font>xmlSecBase64CtxPtr</font> ctx); +<font>int</font> <a href="xmlsec-base64.html#XMLSECBASE64CTXINITIALIZE">xmlSecBase64CtxInitialize</a> (<font>xmlSecBase64CtxPtr</font> ctx, + <font>int</font> encode, + <font>int</font> columns); +<font>void</font> <a href="xmlsec-base64.html#XMLSECBASE64CTXFINALIZE">xmlSecBase64CtxFinalize</a> (<font>xmlSecBase64CtxPtr</font> ctx); +<font>int</font> <a href="xmlsec-base64.html#XMLSECBASE64CTXUPDATE">xmlSecBase64CtxUpdate</a> (<font>xmlSecBase64CtxPtr</font> ctx, + const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *in, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> inSize, + <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *out, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> outSize); +<font>int</font> <a href="xmlsec-base64.html#XMLSECBASE64CTXFINAL">xmlSecBase64CtxFinal</a> (<font>xmlSecBase64CtxPtr</font> ctx, + <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *out, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> outSize); +<font>xmlChar</font>* <a href="xmlsec-base64.html#XMLSECBASE64ENCODE">xmlSecBase64Encode</a> (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buf, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> len, + <font>int</font> columns); +<font>int</font> <a href="xmlsec-base64.html#XMLSECBASE64DECODE">xmlSecBase64Decode</a> (const <font>xmlChar</font> *str, + <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buf, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> len);</pre> </div> <div class="REFSECT1"> <a name="XMLSEC-BASE64.DESCRIPTION"></a><h2>Description</h2> @@ -122,50 +122,54 @@ <div class="REFSECT1"> <a name="XMLSEC-BASE64.DETAILS"></a><h2>Details</h2> <div class="REFSECT2"> -<a name="XMLSEC-BASE64-LINESIZE:CAPS"></a><h3>XMLSEC_BASE64_LINESIZE</h3> -<pre class="PROGRAMLISTING">#define XMLSEC_BASE64_LINESIZE 64</pre> +<a name="XMLSEC-BASE64-LINESIZE--CAPS"></a><h3>XMLSEC_BASE64_LINESIZE</h3> +<pre class="PROGRAMLISTING">#define XMLSEC_BASE64_LINESIZE 64</pre> <p>The default maximum base64 encoded line size.</p> +<p></p> </div> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64GETDEFAULTLINESIZE"></a><h3>xmlSecBase64GetDefaultLineSize ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBase64GetDefaultLineSize (<code class="PARAMETER"><span class="TYPE">void</span></code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecBase64GetDefaultLineSize (void);</pre> <p>Gets the current default line size.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN3031"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN2584"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p> the current default line size.</p></td> </tr></tbody></table> </div> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64SETDEFAULTLINESIZE"></a><h3>xmlSecBase64SetDefaultLineSize ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink> xmlSecBase64SetDefaultLineSize (<code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> columns</code>);</pre> +<pre class="PROGRAMLISTING"><font>void</font> xmlSecBase64SetDefaultLineSize (<font>int</font> columns);</pre> <p>Sets the current default line size.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN3048"><span style="white-space: nowrap"><code class="PARAMETER">columns</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>number of columns</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2599"><span style="white-space: nowrap"><code class="PARAMETER">columns</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> number of columns</p></td> </tr></tbody></table> </div> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64CTXCREATE"></a><h3>xmlSecBase64CtxCreate ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLSECBASE64CTX"><span class="RETURNVALUE">xmlSecBase64CtxPtr</span></gtkdoclink> xmlSecBase64CtxCreate (<code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> encode</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> columns</code>);</pre> +<pre class="PROGRAMLISTING"><font>xmlSecBase64CtxPtr</font> xmlSecBase64CtxCreate (<font>int</font> encode, + <font>int</font> columns);</pre> <p>Allocates and initializes new base64 context.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3068"><span style="white-space: nowrap"><code class="PARAMETER">encode</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the encode/decode flag (1 - encode, 0 - decode)</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2615"><span style="white-space: nowrap"><code class="PARAMETER">encode</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the encode/decode flag (1 - encode, 0 - decode) </p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3073"><span style="white-space: nowrap"><code class="PARAMETER">columns</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the max line length.</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2620"><span style="white-space: nowrap"><code class="PARAMETER">columns</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the max line length.</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3078"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN2625"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> <td align="LEFT" valign="TOP"><p> a pointer to newly created <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure or NULL if an error occurs.</p></td> </tr> @@ -174,37 +178,39 @@ or NULL if an error occurs.</p></td> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64CTXDESTROY"></a><h3>xmlSecBase64CtxDestroy ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink> xmlSecBase64CtxDestroy (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>);</pre> +<pre class="PROGRAMLISTING"><font>void</font> xmlSecBase64CtxDestroy (<font>xmlSecBase64CtxPtr</font> ctx);</pre> <p>Destroys base64 context.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN3097"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure.</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2642"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure.</p></td> </tr></tbody></table> </div> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64CTXINITIALIZE"></a><h3>xmlSecBase64CtxInitialize ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBase64CtxInitialize (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> encode</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> columns</code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecBase64CtxInitialize (<font>xmlSecBase64CtxPtr</font> ctx, + <font>int</font> encode, + <font>int</font> columns);</pre> <p>Initializes new base64 context.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3122"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure,</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2661"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure,</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3129"><span style="white-space: nowrap"><code class="PARAMETER">encode</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the encode/decode flag (1 - encode, 0 - decode)</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2668"><span style="white-space: nowrap"><code class="PARAMETER">encode</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the encode/decode flag (1 - encode, 0 - decode) </p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3134"><span style="white-space: nowrap"><code class="PARAMETER">columns</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the max line length.</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2673"><span style="white-space: nowrap"><code class="PARAMETER">columns</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the max line length.</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3139"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><a name="AEN2678"><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 value otherwise.</p></td> </tr> </tbody></table> @@ -212,48 +218,50 @@ or NULL if an error occurs.</p></td> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64CTXFINALIZE"></a><h3>xmlSecBase64CtxFinalize ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="VOID"><span class="RETURNVALUE">void</span></gtkdoclink> xmlSecBase64CtxFinalize (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>);</pre> +<pre class="PROGRAMLISTING"><font>void</font> xmlSecBase64CtxFinalize (<font>xmlSecBase64CtxPtr</font> ctx);</pre> <p>Frees all the resources allocated by <code class="PARAMETER">ctx</code>.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody><tr> -<td align="LEFT" valign="TOP"><a name="AEN3157"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure,</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2694"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure,</p></td> </tr></tbody></table> </div> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64CTXUPDATE"></a><h3>xmlSecBase64CtxUpdate ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBase64CtxUpdate (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>, - <code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *in</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> inSize</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *out</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> outSize</code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecBase64CtxUpdate (<font>xmlSecBase64CtxPtr</font> ctx, + const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *in, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> inSize, + <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *out, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> outSize);</pre> <p>Encodes or decodes the next piece of data from input buffer.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3188"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2715"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3195"><span style="white-space: nowrap"><code class="PARAMETER">in</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the input buffer</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2722"><span style="white-space: nowrap"><code class="PARAMETER">in</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the input buffer</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3200"><span style="white-space: nowrap"><code class="PARAMETER">inSize</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the input buffer size</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2727"><span style="white-space: nowrap"><code class="PARAMETER">inSize</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the input buffer size</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3205"><span style="white-space: nowrap"><code class="PARAMETER">out</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the output buffer</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2732"><span style="white-space: nowrap"><code class="PARAMETER">out</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the output buffer</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3210"><span style="white-space: nowrap"><code class="PARAMETER">outSize</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the output buffer size</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2737"><span style="white-space: nowrap"><code class="PARAMETER">outSize</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the output buffer size</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3215"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p> the number of bytes written to output buffer or +<td align="LEFT" valign="TOP"><a name="AEN2742"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the number of bytes written to output buffer or -1 if an error occurs.</p></td> </tr> </tbody></table> @@ -261,28 +269,29 @@ or NULL if an error occurs.</p></td> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64CTXFINAL"></a><h3>xmlSecBase64CtxFinal ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBase64CtxFinal (<code class="PARAMETER"><gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64CtxPtr</span></gtkdoclink> ctx</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *out</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> outSize</code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecBase64CtxFinal (<font>xmlSecBase64CtxPtr</font> ctx, + <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *out, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> outSize);</pre> <p>Encodes or decodes the last piece of data stored in the context and finalizes the result.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3238"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2759"><span style="white-space: nowrap"><code class="PARAMETER">ctx</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the pointer to <gtkdoclink href="XMLSECBASE64CTX"><span class="TYPE">xmlSecBase64Ctx</span></gtkdoclink> structure</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3245"><span style="white-space: nowrap"><code class="PARAMETER">out</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the output buffer</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2766"><span style="white-space: nowrap"><code class="PARAMETER">out</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the output buffer</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3250"><span style="white-space: nowrap"><code class="PARAMETER">outSize</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the output buffer size</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2771"><span style="white-space: nowrap"><code class="PARAMETER">outSize</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the output buffer size</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3255"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p> the number of bytes written to output buffer or +<td align="LEFT" valign="TOP"><a name="AEN2776"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the number of bytes written to output buffer or -1 if an error occurs.</p></td> </tr> </tbody></table> @@ -290,30 +299,31 @@ and finalizes the result.</p> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64ENCODE"></a><h3>xmlSecBase64Encode ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="XMLCHAR"><span class="RETURNVALUE">xmlChar</span></gtkdoclink>* xmlSecBase64Encode (<code class="PARAMETER">const <a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *buf</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> len</code>, - <code class="PARAMETER"><gtkdoclink href="INT"><span class="TYPE">int</span></gtkdoclink> columns</code>);</pre> +<pre class="PROGRAMLISTING"><font>xmlChar</font>* xmlSecBase64Encode (const <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buf, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> len, + <font>int</font> columns);</pre> <p>Encodes the data from input buffer and allocates the string for the result. The caller is responsible for freeing returned buffer using <gtkdoclink href="XMLFREE"><code class="FUNCTION">xmlFree()</code></gtkdoclink> function.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3280"><span style="white-space: nowrap"><code class="PARAMETER">buf</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the input buffer.</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2795"><span style="white-space: nowrap"><code class="PARAMETER">buf</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the input buffer.</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3285"><span style="white-space: nowrap"><code class="PARAMETER">len</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the input buffer size.</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2800"><span style="white-space: nowrap"><code class="PARAMETER">len</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the input buffer size.</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3290"><span style="white-space: nowrap"><code class="PARAMETER">columns</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the output max line length (if 0 then no line breaks - would be inserted)</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2805"><span style="white-space: nowrap"><code class="PARAMETER">columns</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the output max line length (if 0 then no line breaks + would be inserted)</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3295"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p> newly allocated string with base64 encoded data +<td align="LEFT" valign="TOP"><a name="AEN2810"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><p> newly allocated string with base64 encoded data or NULL if an error occurs.</p></td> </tr> </tbody></table> @@ -321,29 +331,30 @@ or NULL if an error occurs.</p></td> <hr> <div class="REFSECT2"> <a name="XMLSECBASE64DECODE"></a><h3>xmlSecBase64Decode ()</h3> -<pre class="PROGRAMLISTING"><gtkdoclink href="INT"><span class="RETURNVALUE">int</span></gtkdoclink> xmlSecBase64Decode (<code class="PARAMETER">const <gtkdoclink href="XMLCHAR"><span class="TYPE">xmlChar</span></gtkdoclink> *str</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECBYTE"><span class="TYPE">xmlSecByte</span></a> *buf</code>, - <code class="PARAMETER"><a href="xmlsec-xmlsec.html#XMLSECSIZE"><span class="TYPE">xmlSecSize</span></a> len</code>);</pre> +<pre class="PROGRAMLISTING"><font>int</font> xmlSecBase64Decode (const <font>xmlChar</font> *str, + <a href="xmlsec-xmlsec.html#XMLSECBYTE">xmlSecByte</a> *buf, + <a href="xmlsec-xmlsec.html#XMLSECSIZE">xmlSecSize</a> len);</pre> <p>Decodes input base64 encoded string and puts result into the output buffer.</p> <p></p> +<p></p> <table class="variablelist" border="0" cellspacing="0" cellpadding="4"><tbody> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3318"><span style="white-space: nowrap"><code class="PARAMETER">str</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the input buffer with base64 encoded string</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2827"><span style="white-space: nowrap"><code class="PARAMETER">str</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the input buffer with base64 encoded string</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3323"><span style="white-space: nowrap"><code class="PARAMETER">buf</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the output buffer</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2832"><span style="white-space: nowrap"><code class="PARAMETER">buf</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the output buffer</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3328"><span style="white-space: nowrap"><code class="PARAMETER">len</code> :</span></a></td> -<td align="LEFT" valign="TOP"><p>the output buffer size</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2837"><span style="white-space: nowrap"><code class="PARAMETER">len</code> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the output buffer size</p></td> </tr> <tr> -<td align="LEFT" valign="TOP"><a name="AEN3333"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> -<td align="LEFT" valign="TOP"><p> the number of bytes written to the output buffer or -a negative value if an error occurs</p></td> +<td align="LEFT" valign="TOP"><a name="AEN2842"><span style="white-space: nowrap"><span class="emphasis"><i class="EMPHASIS">Returns</i></span> :</span></a></td> +<td align="LEFT" valign="TOP"><p> the number of bytes written to the output buffer or +a negative value if an error occurs </p></td> </tr> </tbody></table> </div> |