cwbOBJ_CreateParmObjHandle

Purpose

Allocate a parameter list object handle. The parameter list object can be used to hold a list of parameters that can be passed in on other APIs.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_CreateParmObjHandle(
                               cwbOBJ_ParmHandle  *parmListHandle,
                               cwbSV_ErrHandle     errorHandle);

Parameters

cwbOBJ_ParmHandle *parmListHandle - output

Handle of the parameter object.

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.

Usage

The cwbOBJ_DeleteParmObjectHandle API must be called to free resources allocated by this call.