<!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"/>
<title>Apache Portable Runtime: Base64 Encoding</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Base64 Encoding</h1> </div>
<div class="ingroups"><a class="el" href="group___a_p_r___util.html">APR Utility Functions</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><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><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><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><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><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><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>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga1f717903883e7405c2a0d0ec5814f865"></a><!-- doxytag: member="apr_base64.h::apr_base64_decode" ref="ga1f717903883e7405c2a0d0ec5814f865" args="(char *plain_dst, const char *coded_src)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>the length of the plain text string </dd></dl>
</div>
</div>
<a class="anchor" id="ga3d8f1517351d8b7a18b8396642b98975"></a><!-- doxytag: member="apr_base64.h::apr_base64_decode_binary" ref="ga3d8f1517351d8b7a18b8396642b98975" args="(unsigned char *plain_dst, const char *coded_src)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>the length of the plain text string </dd></dl>
</div>
</div>
<a class="anchor" id="gad1ba714a6708376e6a21722a40a698a2"></a><!-- doxytag: member="apr_base64.h::apr_base64_decode_len" ref="gad1ba714a6708376e6a21722a40a698a2" args="(const char *coded_src)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">coded_src</td><td>The encoded string </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the maximum required buffer length for the plain text string </dd></dl>
</div>
</div>
<a class="anchor" id="ga6176124b05512773de40cc5e899058b9"></a><!-- doxytag: member="apr_base64.h::apr_base64_encode" ref="ga6176124b05512773de40cc5e899058b9" args="(char *coded_dst, const char *plain_src, int len_plain_src)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>the length of the encoded string </dd></dl>
</div>
</div>
<a class="anchor" id="gae7480ce6b723e71cf91583217d96f1d7"></a><!-- doxytag: member="apr_base64.h::apr_base64_encode_binary" ref="gae7480ce6b723e71cf91583217d96f1d7" args="(char *coded_dst, const unsigned char *plain_src, int len_plain_src)" -->
<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><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>the length of the encoded string </dd></dl>
</div>
</div>
<a class="anchor" id="ga5dad9df13a7018e3946a54c8d2c27ae9"></a><!-- doxytag: member="apr_base64.h::apr_base64_encode_len" ref="ga5dad9df13a7018e3946a54c8d2c27ae9" args="(int len)" -->
<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-encrypted string, get the length of the encrypted string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">len</td><td>the length of an unencrypted string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the length of the string after it is encrypted </dd></dl>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 for Apache Portable Runtime by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
