cwbOBJ_CloseList

Purpose

Closes an opened list.

Syntax

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

Parameters

cwbOBJ_ListHandle listHandle - input

Handle of the list to be closed. This list must be opened.

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 an allocated list handle.

CWBOBJ_RC_LIST_NOT_OPEN

The list isn't open.

Usage

Closing the list frees the memory used by the list to hold its items. Any object handles gotten with cwbOBJ_GetObjHandle() API should be released before closing the list to free resources. These handles are no longer valid.