Component blpapi_versioninfo [Package (Isolated) blpapi]

Provide BLPAPI SDK library version information. More...

Namespaces
namespace	blpapi

---

Detailed Description

Provide BLPAPI SDK library version information.

Outline

• Purpose
• Classes
• Description
  • Usage
    • C++ usage
    • C usage

Purpose:

Provide BLPAPI SDK library version information.

Classes:

blpapi::VersionInfo

basic BLPAPI SDK library version attribute class

Description:

This component provides access the BLPAPI SDK library version information.

Usage:

C++ usage:

This example logs the BLPAPI version in order to make the logs analysis more productive:

  blpapi::VersionInfo blpapiVersion;
  // Client log the library version for reference and future debugging
  log("BLPAPI version: %d.%d.%d.%d",
      blpapiVersion.majorVersion(),
      blpapiVersion.minorVersion(),
      blpapiVersion.patchVersion(),
      blpapiVersion.buildVersion());

C usage:

This example logs the BLPAPI version in order to make the logs analysis more productive:

  int majorVersion, minorVersion, patchVersion, buildVersion;
  blpapi_getVersionInfo(&majorVersion, &minorVersion, &patchVersion,
      &buildVersion);
  // Client log the library version for reference and future debugging
  log("BLPAPI version: %d.%d.%d.%d", majorVersion, minorVersion,
      patchVersion, buildVersion);

This example provide shows how to use the backward API signature compatibility macros BLPAPI_SDK_VERSION and BLPAPI_MAKE_VERSION (see blpapi_dispatchtbl.h):

  #if BLPAPI_SDK_VERSION >= BLPAPI_MAKE_VERSION(3, 3, 7)
      // Do version 3.3.7 specific stuff here (e.g. adding functions with old
      // signature to an array so a client code that was compiled with
      // version 3.3.7 will still be able to run using the new version.
      ...
  #elif BLPAPI_SDK_VERSION ...