cwbOBJ_GetNPServerAttr

Purpose

Get an attribute of the QNPSERVR program on a specified system.

Syntax

 
unsigned int CWB_ENTRY cwbOBJ_GetNPServerAttr(
                              const char      *systemName,
                              cwbOBJ_KeyID     key,
                              void            *buffer,
                              unsigned long    bufLen,
                              unsigned long   *bytesNeeded,
                              cwbOBJ_DataType *keyType,
                              cwbSV_ErrHandle  errorHandle);

Parameters

const char *systemName - input

Pointer to the system name contained in an ASCIIZ string.

cwbOBJ_KeyID key - input

Identifying key of the attribute to retrieve.

void *buffer - output

The buffer that will hold the attribute value. If this call returns successfully. The value of the key determines what type of data will be put into pBuffer. The type is also returned to the *keyType parameter, if provided.

unsigned long bufLen - input

The length of the buffer pointed to by pBuffer.

unsigned long *bytesNeeded - output

On output, this will be the number of bytes needed to hold result.

cwbOBJ_DataType *keyType - output

Optional, may be NULL. On output this will contain the type of data used to represent this attribute and what is stored at *buffer.

cwbSV_ErrHandle errorHandle - output

Optional, may be 0. Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle() API. The messages may be retrieved through the cwbSV_GetErrText() API. If the parameter is set to zero, no messages will be retrievable.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory.

CWB_BUFFER_OVERFLOW

Buffer too small.

CWB_INVALID_PARAMETER

Invalid parameter specified.

CWBOBJ_RC_HOST_ERROR

Host error occurred. Text may be in errorHandle.

CWBOBJ_RC_INVALID_KEY

Key isn't valid.

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 following attributes may be retrieved from the QNPSERVR program:

• CWBOBJ_KEY_NPSCCSID - Server CCSID
• CWBOBJ_KEY_NPSLEVEL - Server code level