cwbOBJ_SetParameter

Purpose

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

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_SetParameter(
                               cwbOBJ_ParmHandle  parmListHandle,
                               cwbOBJ_KeyID       key,
                               const void        *value,
                               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 *value - input

The value to set the parameter to. The type that value points to is determined by the value of key.

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_NO_ERROR

Successful completion.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory.

CWB_INVALID_HANDLE

Handle is not a parameter object handle.

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

None