cwbCO_GetHostVersion

Purpose

Get the version and release level of the host.

Syntax

 
unsigned int CWB_ENTRY cwbCO_GetHostVersion(
                             LPCSTR         system,
                             unsigned int * version,
                             unsigned int * release );

Parameters

LPCSTR systemName - input

Pointer to a buffer that contains the system name.

unsigned int * version - output

Pointer to a buffer where the version level of the system is returned.

unsigned int * release - output

Pointer to a buffer where the release level of the system is returned.

Return Codes

The following list shows common return values:

CWB_OK

Successful Completion.

CWBCO_SYSTEM_NOT_CONFIGURED

The system is not configured in the currently active environment.

CWBCO_SYSTEM_NOT_CONNECTED

The system has never been connected to when using the currently active environment.

CWB_INVALID_POINTER

One of the pointers passed is NULL.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory; may have failed to allocate temporary buffer.

CWB_NON_REPRESENTABLE_UNICODE_CHAR

One or more input Unicode characters have no representation in the codepage being used.

CWB_API_ERROR

General API failure.

Usage

The host version is retrieved and saved whenever a connection is made to the system; this API does not go to the host to get it on each call. The system must have been connected previously, though not necessarily at the time the API is called. Host information can only be retrieved for systems configured in the currently active environment.