<!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/version.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/version.h File Reference</div> </div> </div> <div class="contents"> <div class="textblock"><code>#include "<a class="el" href="config_8h_source.html">polarssl/config.h</a>"</code><br/> </div> <p><a href="version_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">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a7b2767c47fe157b1fe766ca30cf37bbc">POLARSSL_VERSION_MAJOR</a>   0</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b6e1f4fcc43a274d44c4eb176ce35ba"></a><!-- doxytag: member="version.h::POLARSSL_VERSION_MINOR" ref="a6b6e1f4fcc43a274d44c4eb176ce35ba" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_VERSION_MINOR</b>   14</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef722623c9ac01acf886d3517ad3d62a"></a><!-- doxytag: member="version.h::POLARSSL_VERSION_PATCH" ref="aef722623c9ac01acf886d3517ad3d62a" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_VERSION_PATCH</b>   3</td></tr> <tr><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>   0x000E0300</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa460d4012331fc73ed6b324512b49b61"></a><!-- doxytag: member="version.h::POLARSSL_VERSION_STRING" ref="aa460d4012331fc73ed6b324512b49b61" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_VERSION_STRING</b>   "0.14.3"</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17f8642e62f11a2a034a99c8a042f710"></a><!-- doxytag: member="version.h::POLARSSL_VERSION_STRING_FULL" ref="a17f8642e62f11a2a034a99c8a042f710" args="" --> #define </td><td class="memItemRight" valign="bottom"><b>POLARSSL_VERSION_STRING_FULL</b>   "PolarSSL 0.14.3"</td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#aced1304cfdfd70b132cadc44a35e2de0">version_get_number</a> ()</td></tr> <tr><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><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> </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> <p>This set of compile-time defines and run-time variables can be used to determine the version number of the PolarSSL library used. </p> </div><hr/><h2>Define Documentation</h2> <a class="anchor" id="a7b2767c47fe157b1fe766ca30cf37bbc"></a><!-- doxytag: member="version.h::POLARSSL_VERSION_MAJOR" ref="a7b2767c47fe157b1fe766ca30cf37bbc" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define POLARSSL_VERSION_MAJOR   0</td> </tr> </table> </div> <div class="memdoc"> <p>The version number x.y.z is split into three parts. Major, Minor, Patchlevel </p> </div> </div> <a class="anchor" id="a8a3f68a90790a378a533add3660ef1f2"></a><!-- doxytag: member="version.h::POLARSSL_VERSION_NUMBER" ref="a8a3f68a90790a378a533add3660ef1f2" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define POLARSSL_VERSION_NUMBER   0x000E0300</td> </tr> </table> </div> <div class="memdoc"> <p>The single version number has the following structure: MMNNPP00 Major version | Minor version | Patch version </p> </div> </div> <hr/><h2>Function Documentation</h2> <a class="anchor" id="aced1304cfdfd70b132cadc44a35e2de0"></a><!-- doxytag: member="version.h::version_get_number" ref="aced1304cfdfd70b132cadc44a35e2de0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int version_get_number </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Get the version number.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>The constructed version number in the format MMNNPP00 (Major, Minor, Patch). </dd></dl> </div> </div> <a class="anchor" id="ad1efb7ce9513b4eb116d772937f90738"></a><!-- doxytag: member="version.h::version_get_string" ref="ad1efb7ce9513b4eb116d772937f90738" args="(char *string)" --> <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><dt><b>Parameters:</b></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><!-- doxytag: member="version.h::version_get_string_full" ref="ab730e4a10a6856812c2dab4a9f14a48b" args="(char *string)" --> <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><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">string</td><td>The string that will receive the value. (Should be at least 18 bytes in size) </td></tr> </table> </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>