xcm_version.h File Reference

Functions and macros to retrieve XCM versioning information. More...

Go to the source code of this file.

Macros
#define	XCM_VERSION_MAJOR   1
#define	XCM_VERSION_MINOR   11
#define	XCM_VERSION_PATCH   2
#define	XCM_VERSION   "1.11.2"
#define	XCM_VERSION_API_MAJOR   0
#define	XCM_VERSION_API_MINOR   26
#define	XCM_VERSION_API   "0.26"

Functions
unsigned int	xcm_version_major (void)
unsigned int	xcm_version_minor (void)
unsigned int	xcm_version_patch (void)
const char *	xcm_version (void)
unsigned int	xcm_version_api_major (void)
unsigned int	xcm_version_api_minor (void)
const char *	xcm_version_api (void)

Detailed Description

Functions and macros to retrieve XCM versioning information.

The library (i.e., implementation) version uses the semver convention.

Function Documentation

xcm_version_major()

unsigned int xcm_version_major

(

void

)

Retrieves the library major version.

This function returns the implementation major version of the library used at run time.

xcm_version_minor()

unsigned int xcm_version_minor

(

void

)

Retrieves the library minor version.

This function returns the implementation minor version of the library used at run time.

xcm_version_patch()

unsigned int xcm_version_patch

(

void

)

Retrieves the library patch version.

This function returns the implementation patch version of the library used at run time.

xcm_version()

const char * xcm_version

(

void

)

Retrieves the library version as a string.

This function returns the version of the library used at run time, in string format.

The string returned is statically allocated, and thus must not be free'd by the caller.

xcm_version_api_major()

unsigned int xcm_version_api_major

(

void

)

Retrieves the XCM API major version.

This function returns the API major version of the library used at run time adheres to.

xcm_version_api_minor()

unsigned int xcm_version_api_minor

(

void

)

Retrieves the XCM API minor version.

This function returns the API minor version of the library used at run time adheres to.

xcm_version_api()

const char * xcm_version_api

(

void

)

Retrieves the library API version as a string.

This function returns the API version of the library used at run time adheres to.

The string returned is statically allocated, and thus must not be free'd by the caller.