<!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>PolarSSL: polarssl/base64.h File Reference</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.4 -->
<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">PolarSSL</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="annotated.html"><span>Classes</span></a></li>
<li class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">polarssl/base64.h File Reference</div> </div>
</div>
<div class="contents">
<p><a href="base64_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a778cc91797eec1df0548e1f4afd997"></a><!-- doxytag: member="base64.h::POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL" ref="a9a778cc91797eec1df0548e1f4afd997" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL</b>   0x0010</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fac8bb4d3ed57b1beb10bf617664a1d"></a><!-- doxytag: member="base64.h::POLARSSL_ERR_BASE64_INVALID_CHARACTER" ref="a8fac8bb4d3ed57b1beb10bf617664a1d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_ERR_BASE64_INVALID_CHARACTER</b>   0x0012</td></tr>
<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="base64_8h.html#a692f1733e95ef2ed1a6c23666d705f28">base64_encode</a> (unsigned char *dst, int *dlen, const unsigned char *src, int slen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode a buffer into base64 format. <a href="#a692f1733e95ef2ed1a6c23666d705f28"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#abfa3e40184ca2cb8215a2b23c1b00c65">base64_decode</a> (unsigned char *dst, int *dlen, const unsigned char *src, int slen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a base64-formatted buffer. <a href="#abfa3e40184ca2cb8215a2b23c1b00c65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="base64_8h.html#a469652530cde1badbb67385c2fe3b9ac">base64_self_test</a> (int verbose)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#a469652530cde1badbb67385c2fe3b9ac"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Copyright (C) 2006-2010, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="abfa3e40184ca2cb8215a2b23c1b00c65"></a><!-- doxytag: member="base64.h::base64_decode" ref="abfa3e40184ca2cb8215a2b23c1b00c65" args="(unsigned char *dst, int *dlen, const unsigned char *src, int slen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int base64_decode </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>dlen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>slen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a base64-formatted buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>destination buffer </td></tr>
<tr><td class="paramname">dlen</td><td>size of the buffer </td></tr>
<tr><td class="paramname">src</td><td>source buffer </td></tr>
<tr><td class="paramname">slen</td><td>amount of data to be decoded</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL, or POLARSSL_ERR_BASE64_INVALID_DATA if the input data is not correct. *dlen is always updated to reflect the amount of data that has (or would have) been written.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Call this function with *dlen = 0 to obtain the required buffer size in *dlen </dd></dl>
</div>
</div>
<a class="anchor" id="a692f1733e95ef2ed1a6c23666d705f28"></a><!-- doxytag: member="base64.h::base64_encode" ref="a692f1733e95ef2ed1a6c23666d705f28" args="(unsigned char *dst, int *dlen, const unsigned char *src, int slen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int base64_encode </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>dlen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>slen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode a buffer into base64 format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>destination buffer </td></tr>
<tr><td class="paramname">dlen</td><td>size of the buffer </td></tr>
<tr><td class="paramname">src</td><td>source buffer </td></tr>
<tr><td class="paramname">slen</td><td>amount of data to be encoded</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL. *dlen is always updated to reflect the amount of data that has (or would have) been written.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Call this function with *dlen = 0 to obtain the required buffer size in *dlen </dd></dl>
</div>
</div>
<a class="anchor" id="a469652530cde1badbb67385c2fe3b9ac"></a><!-- doxytag: member="base64.h::base64_self_test" ref="a469652530cde1badbb67385c2fe3b9ac" args="(int verbose)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int base64_self_test </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>verbose</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checkup routine. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, or 1 if the test failed </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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Defines</a></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>
<hr class="footer"/><address class="footer"><small>Generated on Mon May 16 2011 for PolarSSL by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
8df484ca79a7b6bb61e4a376e1506870
>
files
>
36
