cwbOBJ_GetParameter

Purpose

Gets the value of a parameter in a parameter list object.

Syntax

 
unsigned int CWB_ENTRY cwbOBJ_GetParameter(
                              cwbOBJ_ParmHandle parmListHandle,
                              cwbOBJ_KeyID      key,
                              void             *buffer,
                              unsigned long     bufLen,
                              unsigned long    *bytesNeeded,
                              cwbOBJ_DataType  *keyType,
                              cwbSV_ErrHandle   errorHandle);

Parameters

cwbOBJ_ParmHandle parmListHandle - input

Handle of the parameter object.

cwbOBJ_KeyID key - input

The id of the parameter to set.

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 buffer.

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_INVALID_HANDLE

Handle is not an allocated object handle.

CWB_BUFFER_OVERFLOW

Buffer too small.

CWBOBJ_RC_KEY_NOT_FOUND

Key isn't specified in parameter list.

CWB_API_ERROR

General API failure.

Usage

None