Analog Devices / mbed-drivers

A collection of Analog Devices drivers for the mbed platform

Embed: (wiki syntax)

« Back to documentation index

Versions
Functions

Versions

Version number querying functions, definitions, and macros. More...

Functions

int sp_get_major_package_version (void)
 Get the major libserialport package version number.
int sp_get_minor_package_version (void)
 Get the minor libserialport package version number.
int sp_get_micro_package_version (void)
 Get the micro libserialport package version number.
const char * sp_get_package_version_string (void)
 Get the libserialport package version number as a string.
int sp_get_current_lib_version (void)
 Get the "current" part of the libserialport library version number.
int sp_get_revision_lib_version (void)
 Get the "revision" part of the libserialport library version number.
int sp_get_age_lib_version (void)
 Get the "age" part of the libserialport library version number.
const char * sp_get_lib_version_string (void)
 Get the libserialport library version number as a string.

Detailed Description

Version number querying functions, definitions, and macros.

This set of API calls returns two different version numbers related to libserialport. The "package version" is the release version number of the libserialport tarball in the usual "major.minor.micro" format, e.g. "0.1.0".

The "library version" is independent of that; it is the libtool version number in the "current:revision:age" format, e.g. "2:0:0". See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details.

Both version numbers (and/or individual components of them) can be retrieved via the API calls at runtime, and/or they can be checked at compile/preprocessor time using the respective macros.

Function Documentation

int sp_get_age_lib_version ( void   )

Get the "age" part of the libserialport library version number.

Returns:
The "age" library version number.
Since:
0.1.0
int sp_get_current_lib_version ( void   )

Get the "current" part of the libserialport library version number.

Returns:
The "current" library version number.
Since:
0.1.0
const char* sp_get_lib_version_string ( void   )

Get the libserialport library version number as a string.

Returns:
The library version number string. The returned string is static and thus should NOT be free'd by the caller.
Since:
0.1.0
int sp_get_major_package_version ( void   )

Get the major libserialport package version number.

Returns:
The major package version number.
Since:
0.1.0
int sp_get_micro_package_version ( void   )

Get the micro libserialport package version number.

Returns:
The micro package version number.
Since:
0.1.0
int sp_get_minor_package_version ( void   )

Get the minor libserialport package version number.

Returns:
The minor package version number.
Since:
0.1.0
const char* sp_get_package_version_string ( void   )

Get the libserialport package version number as a string.

Returns:
The package version number string. The returned string is static and thus should NOT be free'd by the caller.
Since:
0.1.0
int sp_get_revision_lib_version ( void   )

Get the "revision" part of the libserialport library version number.

Returns:
The "revision" library version number.
Since:
0.1.0
Generated on Tue Jul 12 2022 17:59:52 by  doxygen 1.7.2