cwbOBJ_DeleteParmObjHandle

Purpose

Deallocate a parameter list object handle and free the resources used by it.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_DeleteParmObjHandle(
                               cwbOBJ_ParmHandle  parmListHandle,
                               cwbSV_ErrHandle    errorHandle);

Parameters

cwbOBJ_ParmHandle parmListHandle - input

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.

CWB_INVALID_HANDLE

Handle is not a parameter object handle.

Usage

After this call returns successfully, the parmListHandle is no longer valid.