BLPAPI C++  3.22.1
VersionInfo Class Reference

#include <blpapi_versioninfo.h>

Public Member Functions

 VersionInfo ()
 
int majorVersion () const
 
int minorVersion () const
 
int patchVersion () const
 
int buildVersion () const
 

Static Public Member Functions

static VersionInfo headerVersion ()
 
static VersionInfo runtimeVersion ()
 
static std::string versionIdentifier ()
 

Detailed Description

This attribute class holds the four integer components of a BLPAPI version number, provides factory methods to obtain such version numbers for both the headers used at compile time and the library loaded at run time, and provides a static function to obtain an opaque version identifier string for use by Bloomberg support.

See Component blpapi_versioninfo

Constructor & Destructor Documentation

◆ VersionInfo()

This function is a synonym for VersionInfo::runtimeVersion(). DEPRECATED

Member Function Documentation

◆ buildVersion()

int buildVersion ( ) const

Return the build version number.

◆ headerVersion()

VersionInfo headerVersion ( )
static

Return a VersionInfo object containing the version of the BLPAPI headers against which the client application was compiled. Note that the version of the BLPAPI library loaded at runtime may be different than the version of the headers against which the code was compiled.

◆ majorVersion()

int majorVersion ( ) const

Return the major version number.

◆ minorVersion()

int minorVersion ( ) const

Return the minor version number.

◆ patchVersion()

int patchVersion ( ) const

Return the patch version number.

◆ runtimeVersion()

VersionInfo runtimeVersion ( )
static

Return a VersionInfo object containing the version of the BLPAPI runtime library that is currently running. Note that the version of the BLPAPI library loaded at runtime may be different than the version of the headers against which the code was compiled.

◆ versionIdentifier()

std::string versionIdentifier ( )
static

Return a string containing a sequence of printable ascii characters (with values from 0x20 to 0x7e, inclusive) identifying the version of the blpapi runtime library. The format of this string is unspecified.


The documentation for this class was generated from the following file: