cwbOBJ_DeleteListHandle

Purpose

Deallocates a list handle that was previously allocated with the cwbOBJ_CreateListHandle() API. This will free any resources associated with the list.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_DeleteListHandle(
                               cwbOBJ_ListHandle  listHandle,
                               cwbSV_ErrHandle    errorHandle);

Parameters

cwbOBJ_ListHandle listHandle - input

List handle that will be deleted.

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_INVALID_HANDLE

List handle not found.

Usage

If the list associated with this handle is opened, this call will close it. If there are opened handles to objects in this list, they will no longer be valid. After this call returns successfully, the list handle is no longer valid.