<!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: version.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="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">version.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Run-time version information.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="config_8h_source.html">config.h</a>"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for version.h:</div>
<div class="dyncontent">
<div class="center"><img src="version_8h__incl.png" border="0" usemap="#version_8h" alt=""/></div>
<map name="version_8h" id="version_8h">
</map>
</div>
</div>
<p><a href="version_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a7b2767c47fe157b1fe766ca30cf37bbc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a7b2767c47fe157b1fe766ca30cf37bbc">POLARSSL_VERSION_MAJOR</a>   1</td></tr>
<tr class="memdesc:a7b2767c47fe157b1fe766ca30cf37bbc"><td class="mdescLeft"> </td><td class="mdescRight">The version number x.y.z is split into three parts. <a href="#a7b2767c47fe157b1fe766ca30cf37bbc">More...</a><br/></td></tr>
<tr class="separator:a7b2767c47fe157b1fe766ca30cf37bbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b6e1f4fcc43a274d44c4eb176ce35ba"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a6b6e1f4fcc43a274d44c4eb176ce35ba">POLARSSL_VERSION_MINOR</a>   3</td></tr>
<tr class="separator:a6b6e1f4fcc43a274d44c4eb176ce35ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef722623c9ac01acf886d3517ad3d62a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#aef722623c9ac01acf886d3517ad3d62a">POLARSSL_VERSION_PATCH</a>   8</td></tr>
<tr class="separator:aef722623c9ac01acf886d3517ad3d62a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a3f68a90790a378a533add3660ef1f2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a8a3f68a90790a378a533add3660ef1f2">POLARSSL_VERSION_NUMBER</a>   0x01030800</td></tr>
<tr class="memdesc:a8a3f68a90790a378a533add3660ef1f2"><td class="mdescLeft"> </td><td class="mdescRight">The single version number has the following structure: MMNNPP00 Major version | Minor version | Patch version. <a href="#a8a3f68a90790a378a533add3660ef1f2">More...</a><br/></td></tr>
<tr class="separator:a8a3f68a90790a378a533add3660ef1f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa460d4012331fc73ed6b324512b49b61"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#aa460d4012331fc73ed6b324512b49b61">POLARSSL_VERSION_STRING</a>   "1.3.8"</td></tr>
<tr class="separator:aa460d4012331fc73ed6b324512b49b61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17f8642e62f11a2a034a99c8a042f710"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a17f8642e62f11a2a034a99c8a042f710">POLARSSL_VERSION_STRING_FULL</a>   "PolarSSL 1.3.8"</td></tr>
<tr class="separator:a17f8642e62f11a2a034a99c8a042f710"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0bc463d1b7abd73209d713ec793173a8"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a0bc463d1b7abd73209d713ec793173a8">version_get_number</a> (void)</td></tr>
<tr class="memdesc:a0bc463d1b7abd73209d713ec793173a8"><td class="mdescLeft"> </td><td class="mdescRight">Get the version number. <a href="#a0bc463d1b7abd73209d713ec793173a8">More...</a><br/></td></tr>
<tr class="separator:a0bc463d1b7abd73209d713ec793173a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1efb7ce9513b4eb116d772937f90738"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#ad1efb7ce9513b4eb116d772937f90738">version_get_string</a> (char *string)</td></tr>
<tr class="memdesc:ad1efb7ce9513b4eb116d772937f90738"><td class="mdescLeft"> </td><td class="mdescRight">Get the version string ("x.y.z"). <a href="#ad1efb7ce9513b4eb116d772937f90738">More...</a><br/></td></tr>
<tr class="separator:ad1efb7ce9513b4eb116d772937f90738"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab730e4a10a6856812c2dab4a9f14a48b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#ab730e4a10a6856812c2dab4a9f14a48b">version_get_string_full</a> (char *string)</td></tr>
<tr class="memdesc:ab730e4a10a6856812c2dab4a9f14a48b"><td class="mdescLeft"> </td><td class="mdescRight">Get the full version string ("PolarSSL x.y.z"). <a href="#ab730e4a10a6856812c2dab4a9f14a48b">More...</a><br/></td></tr>
<tr class="separator:ab730e4a10a6856812c2dab4a9f14a48b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a237482a8c469b7d68c618e2cca72f1e0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a237482a8c469b7d68c618e2cca72f1e0">version_check_feature</a> (const char *feature)</td></tr>
<tr class="memdesc:a237482a8c469b7d68c618e2cca72f1e0"><td class="mdescLeft"> </td><td class="mdescRight">Check if support for a feature was compiled into this PolarSSL binary. <a href="#a237482a8c469b7d68c618e2cca72f1e0">More...</a><br/></td></tr>
<tr class="separator:a237482a8c469b7d68c618e2cca72f1e0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Run-time version information. </p>
<p>Copyright (C) 2006-2014, 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="version_8h_source.html">version.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a7b2767c47fe157b1fe766ca30cf37bbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_VERSION_MAJOR   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>The version number x.y.z is split into three parts. </p>
<p>Major, Minor, Patchlevel </p>
<p>Definition at line <a class="el" href="version_8h_source.html#l00044">44</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6b6e1f4fcc43a274d44c4eb176ce35ba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_VERSION_MINOR   3</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="version_8h_source.html#l00045">45</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8a3f68a90790a378a533add3660ef1f2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_VERSION_NUMBER   0x01030800</td>
</tr>
</table>
</div><div class="memdoc">
<p>The single version number has the following structure: MMNNPP00 Major version | Minor version | Patch version. </p>
<p>Definition at line <a class="el" href="version_8h_source.html#l00053">53</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a class="anchor" id="aef722623c9ac01acf886d3517ad3d62a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_VERSION_PATCH   8</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="version_8h_source.html#l00046">46</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa460d4012331fc73ed6b324512b49b61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_VERSION_STRING   "1.3.8"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="version_8h_source.html#l00054">54</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a class="anchor" id="a17f8642e62f11a2a034a99c8a042f710"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define POLARSSL_VERSION_STRING_FULL   "PolarSSL 1.3.8"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="version_8h_source.html#l00055">55</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a237482a8c469b7d68c618e2cca72f1e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int version_check_feature </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>feature</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if support for a feature was compiled into this PolarSSL binary. </p>
<p>This allows you to see at runtime if the library was for instance compiled with or without Multi-threading support.</p>
<p>Note: only checks against defines in the sections "System
support", "PolarSSL modules" and "PolarSSL feature
support" in <a class="el" href="config_8h.html" title="Configuration options (set of defines) ">config.h</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">feature</td><td>The string for the define to check (e.g. "POLARSSL_AES_C")</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if the feature is present, -1 if the feature is not present and -2 if support for feature checking as a whole was not compiled in. </dd></dl>
</div>
</div>
<a class="anchor" id="a0bc463d1b7abd73209d713ec793173a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int version_get_number </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the version number. </p>
<dl class="section return"><dt>Returns</dt><dd>The constructed version number in the format MMNNPP00 (Major, Minor, Patch). </dd></dl>
</div>
</div>
<a class="anchor" id="ad1efb7ce9513b4eb116d772937f90738"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void version_get_string </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>string</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the version string ("x.y.z"). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>The string that will receive the value. (Should be at least 9 bytes in size) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab730e4a10a6856812c2dab4a9f14a48b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void version_get_string_full </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>string</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the full version string ("PolarSSL x.y.z"). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>The string that will receive the value. The PolarSSL version string will use 18 bytes AT MOST including a terminating null byte. (So the buffer should be at least 18 bytes to receive this version string). </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>
