<!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.5"/>
<title>PolarSSL v1.3.8: error.h File Reference</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="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 style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></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>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">error.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Error to string translation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <string.h></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for error.h:</div>
<div class="dyncontent">
<div class="center"><img src="error_8h__incl.png" border="0" usemap="#error_8h" alt=""/></div>
<map name="error_8h" id="error_8h">
</map>
</div>
</div>
<p><a href="error_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:add283205ae72845bf6b53e8333df58c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8h.html#add283205ae72845bf6b53e8333df58c8">polarssl_strerror</a> (int errnum, char *buffer, size_t buflen)</td></tr>
<tr class="memdesc:add283205ae72845bf6b53e8333df58c8"><td class="mdescLeft"> </td><td class="mdescRight">Error code layout. <a href="#add283205ae72845bf6b53e8333df58c8">More...</a><br/></td></tr>
<tr class="separator:add283205ae72845bf6b53e8333df58c8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Error to string translation. </p>
<p>Copyright (C) 2006-2013, 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>
<p>Definition in file <a class="el" href="error_8h_source.html">error.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="add283205ae72845bf6b53e8333df58c8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void polarssl_strerror </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>errnum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>buflen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error code layout. </p>
<p>Currently we try to keep all error codes within the negative space of 16 bytes signed integers to support all platforms (-0x0000 - -0x8000). In addition we'd like to give two layers of information on the error if possible.</p>
<p>For that purpose the error codes are segmented in the following manner:</p>
<p>16 bit error code bit-segmentation</p>
<p>1 bit - Sign bit 3 bits - High level module ID 5 bits - Module-dependent error code 7 bits - Low level module errors</p>
<p>For historical reasons, low-level error codes are divided in even and odd, even codes were assigned first, and -1 is reserved for other errors.</p>
<p>Low-level module errors (0x0002-0x007E, 0x0003-0x007F)</p>
<p>Module Nr Codes assigned MPI 7 0x0002-0x0010 GCM 2 0x0012-0x0014 BLOWFISH 2 0x0016-0x0018 THREADING 3 0x001A-0x001E AES 2 0x0020-0x0022 CAMELLIA 2 0x0024-0x0026 XTEA 1 0x0028-0x0028 BASE64 2 0x002A-0x002C OID 1 0x002E-0x002E 0x000B-0x000B PADLOCK 1 0x0030-0x0030 DES 1 0x0032-0x0032 CTR_DBRG 4 0x0034-0x003A ENTROPY 3 0x003C-0x0040 NET 11 0x0042-0x0056 ENTROPY 1 0x0058-0x0058 ASN1 7 0x0060-0x006C MD2 1 0x0070-0x0070 MD4 1 0x0072-0x0072 MD5 1 0x0074-0x0074 SHA1 1 0x0076-0x0076 SHA256 1 0x0078-0x0078 SHA512 1 0x007A-0x007A PBKDF2 1 0x007C-0x007C RIPEMD160 1 0x007E-0x007E HMAC_DRBG 4 0x0003-0x0009 CCM 2 0x000D-0x000F</p>
<p>High-level module nr (3 bits - 0x0...-0x7...) Name ID Nr of Errors PEM 1 9 PKCS#12 1 4 (Started from top) X509 2 18 PK 2 14 (Started from top, plus 0x2000) DHM 3 9 PKCS5 3 4 (Started from top) RSA 4 9 ECP 4 8 (Started from top) MD 5 4 CIPHER 6 6 SSL 6 9 (Started from top) SSL 7 31</p>
<p>Module dependent error code (5 bits 0x.00.-0x.F8.) Translate a PolarSSL error code into a string representation, Result is truncated if necessary and always includes a terminating null byte.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">errnum</td><td>error code </td></tr>
<tr><td class="paramname">buffer</td><td>buffer to place representation in </td></tr>
<tr><td class="paramname">buflen</td><td>length of the buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:56 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
