Purpose
Creates a handle to a list of configured
system names in the active environment.
Syntax
unsigned int CWB_ENTRY cwbCO_CreateSysListHandle(
cwbCO_SysListHandle *listHandle,
cwbSV_ErrHandle errorHandle);
Parameters
- cwbCO_SysListHandle *listHandle - output
- Pointer to a list handle that will be passed back on output. This handle
is needed for other calls using the list.
- cwbSV_ErrorHandle errorHandle - input
- If the API call fails, the message object that is associated with this
handle will be filled in with message text that describes the error. If this
parameter is zero, no messages will be available.
Return Codes
The following list shows common return
values:
- CWB_OK
- Successful Completion.
- CWB_NOT_ENOUGH_MEMORY
- Insufficient memory.
- CWB_INVALID_POINTER
- Pointer to the list handle is NULL.
Usage
cwbCO_DeleteSysListHandle must
be called to free resources that are allocated with this API.