cwbUN_GetUserAttribute

Purpose

Returns a string that contains the value of a user profile attribute for the current iSeries™ Navigator user.

Syntax

CWBAPI unsigned int WINAPI cwbUN_GetUserAttribute(
    USHORT usAttributeId,
    const char * szSystemName,
    char * szValue,
    UINT cchMax
    );

Parameters

USHORT usAttributeId - input

A numeric value which identifies the user attribute value to be retrieved. Definitions for the user attribute constants are in the header file 'CWBA4USR.H.'

const char * szSystemName - input

The name of the iSeries system from which to retrieve the user attribute.

char * szValue - output

Address of the buffer that will receive the null-terminated attribute 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 attribute 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 an NLS string and is not translated. For example, '*NONE' will be returned instead of 'None.'