Purpose
Open the list. This actually builds the
list. Caller must call the cwbOBJ_ClostList() API when
done with the list to free resources. After the list is opened, the caller
may use other APIs on the list to do things such as get the list size and
get object handles to items in the list.
Syntax
unsigned int CWB_ENTRY cwbOBJ_OpenList(
cwbOBJ_ListHandle listHandle,
cwbOBJ_List_OpenType openType,
cwbSV_ErrHandle errorHandle);
Parameters
- cwbOBJ_ListHandle listHandle - input
- Handle of the list to open.
- cwbOBJ_List_OpenType openHandle - input
- Manner in which to open the list. Must be set to CWBOBJ_LIST_OPEN_SYNCH
- 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_OPEN
- The list is already open.
- CWBOBJ_RC_HOST_ERROR
- Host error occurred. Text may be in errorHandle.
- CWBOBJ_RC_NOHOSTSUPPORT
- Host doesn't support this type of list.