<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbed TLS v2.7.3: 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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mbed TLS v2.7.3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</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:a5a7d810a2d7cf4dd3ef85fd9fa3175d5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a5a7d810a2d7cf4dd3ef85fd9fa3175d5">MBEDTLS_VERSION_MAJOR</a>   2</td></tr>
<tr class="separator:a5a7d810a2d7cf4dd3ef85fd9fa3175d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64cf9914ef37c1d591dea65bd99e5f6e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a64cf9914ef37c1d591dea65bd99e5f6e">MBEDTLS_VERSION_MINOR</a>   7</td></tr>
<tr class="separator:a64cf9914ef37c1d591dea65bd99e5f6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa507dab4f28a259909714c4c50cccfc7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#aa507dab4f28a259909714c4c50cccfc7">MBEDTLS_VERSION_PATCH</a>   3</td></tr>
<tr class="separator:aa507dab4f28a259909714c4c50cccfc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb4f54ebb33fd1a25e2c4d4480cf4936"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#adb4f54ebb33fd1a25e2c4d4480cf4936">MBEDTLS_VERSION_NUMBER</a>   0x02070300</td></tr>
<tr class="separator:adb4f54ebb33fd1a25e2c4d4480cf4936"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1433dae2f973235284ed1b1390e585be"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a1433dae2f973235284ed1b1390e585be">MBEDTLS_VERSION_STRING</a>   "2.7.3"</td></tr>
<tr class="separator:a1433dae2f973235284ed1b1390e585be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3672345ea6deef6e023fcecdee97820"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#aa3672345ea6deef6e023fcecdee97820">MBEDTLS_VERSION_STRING_FULL</a>   "mbed TLS 2.7.3"</td></tr>
<tr class="separator:aa3672345ea6deef6e023fcecdee97820"><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:a3d780043d5104f5e5863255dd55b3951"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a3d780043d5104f5e5863255dd55b3951">mbedtls_version_get_number</a> (void)</td></tr>
<tr class="separator:a3d780043d5104f5e5863255dd55b3951"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4fd0e3ea2523313ea177477d6c93bdd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#af4fd0e3ea2523313ea177477d6c93bdd">mbedtls_version_get_string</a> (char *string)</td></tr>
<tr class="separator:af4fd0e3ea2523313ea177477d6c93bdd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a779eef1940de834a3d223a2339c2a9bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#a779eef1940de834a3d223a2339c2a9bb">mbedtls_version_get_string_full</a> (char *string)</td></tr>
<tr class="separator:a779eef1940de834a3d223a2339c2a9bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe471be7bb2bd441b0c693256ab298ea"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="version_8h.html#afe471be7bb2bd441b0c693256ab298ea">mbedtls_version_check_feature</a> (const char *feature)</td></tr>
<tr class="memdesc:afe471be7bb2bd441b0c693256ab298ea"><td class="mdescLeft"> </td><td class="mdescRight">Check if support for a feature was compiled into this mbed TLS binary. This allows you to see at runtime if the library was for instance compiled with or without Multi-threading support. <a href="#afe471be7bb2bd441b0c693256ab298ea">More...</a><br /></td></tr>
<tr class="separator:afe471be7bb2bd441b0c693256ab298ea"><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 class="definition">Definition in file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a5a7d810a2d7cf4dd3ef85fd9fa3175d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a7d810a2d7cf4dd3ef85fd9fa3175d5">◆ </a></span>MBEDTLS_VERSION_MAJOR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_VERSION_MAJOR   2</td>
</tr>
</table>
</div><div class="memdoc">
<p>The version number x.y.z is split into three parts. Major, Minor, Patchlevel </p>
<p class="definition">Definition at line <a class="el" href="version_8h_source.html#l00041">41</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a id="a64cf9914ef37c1d591dea65bd99e5f6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64cf9914ef37c1d591dea65bd99e5f6e">◆ </a></span>MBEDTLS_VERSION_MINOR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_VERSION_MINOR   7</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="version_8h_source.html#l00042">42</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a id="adb4f54ebb33fd1a25e2c4d4480cf4936"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb4f54ebb33fd1a25e2c4d4480cf4936">◆ </a></span>MBEDTLS_VERSION_NUMBER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_VERSION_NUMBER   0x02070300</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 class="definition">Definition at line <a class="el" href="version_8h_source.html#l00050">50</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a id="aa507dab4f28a259909714c4c50cccfc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa507dab4f28a259909714c4c50cccfc7">◆ </a></span>MBEDTLS_VERSION_PATCH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_VERSION_PATCH   3</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="version_8h_source.html#l00043">43</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a id="a1433dae2f973235284ed1b1390e585be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1433dae2f973235284ed1b1390e585be">◆ </a></span>MBEDTLS_VERSION_STRING</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_VERSION_STRING   "2.7.3"</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="version_8h_source.html#l00051">51</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<a id="aa3672345ea6deef6e023fcecdee97820"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3672345ea6deef6e023fcecdee97820">◆ </a></span>MBEDTLS_VERSION_STRING_FULL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MBEDTLS_VERSION_STRING_FULL   "mbed TLS 2.7.3"</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="version_8h_source.html#l00052">52</a> of file <a class="el" href="version_8h_source.html">version.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="afe471be7bb2bd441b0c693256ab298ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe471be7bb2bd441b0c693256ab298ea">◆ </a></span>mbedtls_version_check_feature()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mbedtls_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 mbed TLS binary. This allows you to see at runtime if the library was for instance compiled with or without Multi-threading support. </p>
<dl class="section note"><dt>Note</dt><dd>only checks against defines in the sections "System
support", "mbed TLS modules" and "mbed TLS feature
support" in <a class="el" href="config_8h.html" title="Configuration options (set of defines) ">config.h</a></dd></dl>
<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. "MBEDTLS_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 id="a3d780043d5104f5e5863255dd55b3951"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d780043d5104f5e5863255dd55b3951">◆ </a></span>mbedtls_version_get_number()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int mbedtls_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 id="af4fd0e3ea2523313ea177477d6c93bdd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4fd0e3ea2523313ea177477d6c93bdd">◆ </a></span>mbedtls_version_get_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_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 id="a779eef1940de834a3d223a2339c2a9bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a779eef1940de834a3d223a2339c2a9bb">◆ </a></span>mbedtls_version_get_string_full()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mbedtls_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 ("mbed TLS 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 mbed TLS 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 Tue May 8 2018 21:08:42 for mbed TLS v2.7.3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
f835bee5b8b7ec08e20fae17cab51e63
>
files
>
633
