cwbUN_GetSystemValue

Purpose

Returns a string that contains the value of an iSeries™ system value.

Syntax

CWBAPI unsigned int WINAPI cwbUN_GetSystemValue(
    USHORT usSystemValueId,
    const char * szSystemName,
    char * szSystemValue,
    UINT cchMax
    );

Parameters

const char * szSystemValueId - input

A numeric value that identifies the iSeries system value to be retrieved. Definitions for the system value constants are in the header file 'CWBA4SVL.H'

char * szSystemValue - output

Address of the buffer that will receive the null-terminated system value string.

UINT cchMax - input

Size of the buffer that will receive the null-terminated value string.

Return Codes

The following list shows common return values:

CWB_OK

Successful completion.

CWBUN_INTERNAL_ERROR

Could not retrieve the system value.

CWB_BUFFER_OVERFLOW

The buffer is too small to contain the returned string.

Usage

The value that is returned by this API is not a National Language Support (NLS) string and is not translated. For example, '*NONE' will be returned instead of 'None.'