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 mbedtls_version_get_number (void)
 Get the version number.
void mbedtls_version_get_string (char *string)
 Get the version string ("x.y.z").
void mbedtls_version_get_string_full (char *string)
 Get the full version string ("mbed TLS x.y.z").
int mbedtls_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.

Definition in file version.h.


Function Documentation

int mbedtls_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. "MBEDTLS_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 700 of file version_features.c.

unsigned int mbedtls_version_get_number ( void   )

Get the version number.

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

Definition at line 33 of file version.c.

void mbedtls_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 38 of file version.c.

void mbedtls_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 44 of file version.c.