Component blpapi_versionmacros

Detailed Description

Provide preprocessor macros for BLPAPI library version information.

Purpose:

Provide preprocessor macros for BLPAPI library version information.

Description:

This file is not meant to be included directly; include blpapi_versioninfo.h for library version interfaces.

Macro Definition Documentation

BLPAPI_MAKE_VERSION

#define BLPAPI_MAKE_VERSION	(		MAJOR,
			MINOR,
			PATCH )

Value:

    ((MAJOR) * 65536 + (MINOR) * 256 + (PATCH))

Combine MAJOR, MINOR, and PATCH into a single integer for compile time version comparisons.

The result equals MAJOR*65536 + MINOR*256 + PATCH.

BLPAPI_SDK_VERSION

#define BLPAPI_SDK_VERSION

Value:

    BLPAPI_MAKE_VERSION(                                                      \
            BLPAPI_VERSION_MAJOR, BLPAPI_VERSION_MINOR, BLPAPI_VERSION_PATCH)

Integer encoding the version of the BLPAPI headers used at compile time.

Compare using BLPAPI_MAKE_VERSION to conditionally compile version-specific code.

BLPAPI_SDK_VERSION_STRING

#define BLPAPI_SDK_VERSION_STRING

Value:

    BLPAPI_STR(BLPAPI_VERSION_MAJOR)                                          \
    "." BLPAPI_STR(BLPAPI_VERSION_MINOR) "." BLPAPI_STR(                      \
            BLPAPI_VERSION_PATCH) "." BLPAPI_STR(BLPAPI_VERSION_BUILD)

C-string encoding the version of the BLPAPI headers used at compile time in "MAJOR.MINOR.PATCH.BUILD" format.

BLPAPI_STR

#define BLPAPI_STR

(

a

)

Value:

BLPAPI_STR2(a)

Helper macro — stringifies its argument after macro expansion.

BLPAPI_STR2

#define BLPAPI_STR2

(

a

)

Value:

#a

Helper macro — stringifies its argument without expansion.

BLPAPI_VERSION_BUILD

#define BLPAPI_VERSION_BUILD   128

BLPAPI SDK build version number.

BLPAPI_VERSION_MAJOR

#define BLPAPI_VERSION_MAJOR   3

BLPAPI SDK major version number.

BLPAPI_VERSION_MINOR

#define BLPAPI_VERSION_MINOR   26

BLPAPI SDK minor version number.

BLPAPI_VERSION_PATCH

#define BLPAPI_VERSION_PATCH   6

BLPAPI SDK patch version number.