mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

Embed: (wiki syntax)

« Back to documentation index

version.h File Reference

version.h File Reference

Run-time version information. More...

Go to the source code of this file.

Functions

unsigned int version_get_number (void)
 Get the version number.
void version_get_string (char *string)
 Get the version string ("x.y.z").
void version_get_string_full (char *string)
 Get the full version string ("mbed TLS x.y.z").
int version_check_feature (const char *feature)
 Check if support for a feature was compiled into this mbed TLS binary.

Detailed Description

Run-time version information.

Copyright (C) 2006-2014, ARM Limited, All Rights Reserved

This file is part of mbed TLS (https://tls.mbed.org)

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.

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.

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.

Definition in file version.h.


Function Documentation

int version_check_feature ( const char *  feature )

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.

Note: only checks against defines in the sections "System support", "mbed TLS modules" and "mbed TLS feature support" in config.h

Parameters:
featureThe string for the define to check (e.g. "POLARSSL_AES_C")
Returns:
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.

Definition at line 571 of file version_features.c.

unsigned int version_get_number ( void   )

Get the version number.

Returns:
The constructed version number in the format MMNNPP00 (Major, Minor, Patch).

Definition at line 34 of file version.c.

void version_get_string ( char *  string )

Get the version string ("x.y.z").

Parameters:
stringThe string that will receive the value. (Should be at least 9 bytes in size)

Definition at line 39 of file version.c.

void version_get_string_full ( char *  string )

Get the full version string ("mbed TLS x.y.z").

Parameters:
stringThe 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).

Definition at line 45 of file version.c.