/
usr
/
share
/
doc
/
libaprutil1-dev
/
html
/
Upload File
HOME
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Apache Portable Runtime Utility Library: Base64 Encoding</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime Utility Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); </script> <div id="main-nav"></div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Base64 Encoding<div class="ingroups"><a class="el" href="group___a_p_r___util.html">APR Utility Functions</a></div></div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Collaboration diagram for Base64 Encoding:</div> <div class="dyncontent"> <center><table><tr><td><img src="group___a_p_r___util___base64.png" border="0" alt="" usemap="#group______a__p__r______util______base64"/> <!-- MAP 0 --> </td></tr></table></center> </div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga5dad9df13a7018e3946a54c8d2c27ae9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___base64.html#ga5dad9df13a7018e3946a54c8d2c27ae9">apr_base64_encode_len</a> (int len)</td></tr> <tr class="separator:ga5dad9df13a7018e3946a54c8d2c27ae9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6176124b05512773de40cc5e899058b9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___base64.html#ga6176124b05512773de40cc5e899058b9">apr_base64_encode</a> (char *coded_dst, const char *plain_src, int len_plain_src)</td></tr> <tr class="separator:ga6176124b05512773de40cc5e899058b9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae7480ce6b723e71cf91583217d96f1d7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___base64.html#gae7480ce6b723e71cf91583217d96f1d7">apr_base64_encode_binary</a> (char *coded_dst, const unsigned char *plain_src, int len_plain_src)</td></tr> <tr class="separator:gae7480ce6b723e71cf91583217d96f1d7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad1ba714a6708376e6a21722a40a698a2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___base64.html#gad1ba714a6708376e6a21722a40a698a2">apr_base64_decode_len</a> (const char *coded_src)</td></tr> <tr class="separator:gad1ba714a6708376e6a21722a40a698a2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga1f717903883e7405c2a0d0ec5814f865"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___base64.html#ga1f717903883e7405c2a0d0ec5814f865">apr_base64_decode</a> (char *plain_dst, const char *coded_src)</td></tr> <tr class="separator:ga1f717903883e7405c2a0d0ec5814f865"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3d8f1517351d8b7a18b8396642b98975"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___base64.html#ga3d8f1517351d8b7a18b8396642b98975">apr_base64_decode_binary</a> (unsigned char *plain_dst, const char *coded_src)</td></tr> <tr class="separator:ga3d8f1517351d8b7a18b8396642b98975"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Function Documentation</h2> <a id="ga1f717903883e7405c2a0d0ec5814f865"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga1f717903883e7405c2a0d0ec5814f865">◆ </a></span>apr_base64_decode()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_base64_decode </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>plain_dst</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>coded_src</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Decode a string to plain text </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">plain_dst</td><td>The destination string for the plain text </td></tr> <tr><td class="paramname">coded_src</td><td>The encoded string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the length of the plain text string </dd></dl> </div> </div> <a id="ga3d8f1517351d8b7a18b8396642b98975"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga3d8f1517351d8b7a18b8396642b98975">◆ </a></span>apr_base64_decode_binary()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_base64_decode_binary </td> <td>(</td> <td class="paramtype">unsigned char * </td> <td class="paramname"><em>plain_dst</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>coded_src</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Decode an EBCDIC string to plain text </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">plain_dst</td><td>The destination string for the plain text </td></tr> <tr><td class="paramname">coded_src</td><td>The encoded string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the length of the plain text string </dd></dl> </div> </div> <a id="gad1ba714a6708376e6a21722a40a698a2"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad1ba714a6708376e6a21722a40a698a2">◆ </a></span>apr_base64_decode_len()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_base64_decode_len </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>coded_src</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Determine the maximum buffer length required to decode the plain text string given the encoded string. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">coded_src</td><td>The encoded string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the maximum required buffer length for the plain text string </dd></dl> </div> </div> <a id="ga6176124b05512773de40cc5e899058b9"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga6176124b05512773de40cc5e899058b9">◆ </a></span>apr_base64_encode()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_base64_encode </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>coded_dst</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>plain_src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>len_plain_src</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Encode a text string using base64encoding. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">coded_dst</td><td>The destination string for the encoded string. </td></tr> <tr><td class="paramname">plain_src</td><td>The original string in plain text </td></tr> <tr><td class="paramname">len_plain_src</td><td>The length of the plain text string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the length of the encoded string </dd></dl> </div> </div> <a id="gae7480ce6b723e71cf91583217d96f1d7"></a> <h2 class="memtitle"><span class="permalink"><a href="#gae7480ce6b723e71cf91583217d96f1d7">◆ </a></span>apr_base64_encode_binary()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_base64_encode_binary </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"><em>coded_dst</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char * </td> <td class="paramname"><em>plain_src</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>len_plain_src</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Encode an EBCDIC string using base64encoding. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">coded_dst</td><td>The destination string for the encoded string. </td></tr> <tr><td class="paramname">plain_src</td><td>The original string in plain text </td></tr> <tr><td class="paramname">len_plain_src</td><td>The length of the plain text string </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the length of the encoded string </dd></dl> </div> </div> <a id="ga5dad9df13a7018e3946a54c8d2c27ae9"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga5dad9df13a7018e3946a54c8d2c27ae9">◆ </a></span>apr_base64_encode_len()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_base64_encode_len </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>len</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Given the length of an un-encoded string, get the length of the encoded string. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">len</td><td>the length of an unencoded string. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the length of the string after it is encoded, including the trailing \0 </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>