ykneomgr-version

ykneomgr-version

Synopsis

#define             YKNEOMGR_VERSION_STRING
#define             YKNEOMGR_VERSION_NUMBER
#define             YKNEOMGR_VERSION_MAJOR
#define             YKNEOMGR_VERSION_MINOR
#define             YKNEOMGR_VERSION_PATCH
const char *        ykneomgr_check_version              (const char *req_version);

Description

Details

YKNEOMGR_VERSION_STRING

#define YKNEOMGR_VERSION_STRING "0.0.3"

Pre-processor symbol with a string that describe the header file version number. Used together with ykneomgr_check_version() to verify header file and run-time library consistency.


YKNEOMGR_VERSION_NUMBER

#define YKNEOMGR_VERSION_NUMBER 0x000003

Pre-processor symbol with a hexadecimal value describing the header file version number. For example, when the header version is 1.2.3 this symbol will have the value 0x01020300. The last two digits are only used between public releases, and will otherwise be 00.


YKNEOMGR_VERSION_MAJOR

#define YKNEOMGR_VERSION_MAJOR 0

Pre-processor symbol with a decimal value that describe the major level of the header file version number. For example, when the header version is 1.2.3 this symbol will be 1.


YKNEOMGR_VERSION_MINOR

#define YKNEOMGR_VERSION_MINOR 0

Pre-processor symbol with a decimal value that describe the minor level of the header file version number. For example, when the header version is 1.2.3 this symbol will be 2.


YKNEOMGR_VERSION_PATCH

#define YKNEOMGR_VERSION_PATCH 3

Pre-processor symbol with a decimal value that describe the patch level of the header file version number. For example, when the header version is 1.2.3 this symbol will be 3.


ykneomgr_check_version ()

const char *        ykneomgr_check_version              (const char *req_version);

Check that the version of the library is at minimum the requested one and return the version string; return NULL if the condition is not satisfied. If a NULL is passed to this function, no check is done, but the version string is simply returned.

See YKNEOMGR_VERSION_STRING for a suitable req_version string.

req_version :

Required version number, or NULL.

Returns :

Version string of run-time library, or NULL if the run-time library does not meet the required version number.