Purpose
Creates a handle to list of configured system
names of the specified environment.
Syntax
unsigned int CWB_ENTRY cwbCO_CreateSysListHandleEnv(
cwbCO_SysListHandle *listHandle,
cwbSV_ErrHandle errorHandle,
LPCSTR pEnvironment );
Parameters
- cwbCO_SysListHandle *listHandle - output
- Pointer to a list handle that will be passed back on output. This handle
is needed for other calls that are 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.
- LPCSTR pEnvironment
- Pointer to a string containing the desired environment name. If pEnvironment
is the NULL pointer, or points to the NULL string ("\0"), the system list
of the current active environment is returned.
Return Codes
The following list shows common return
values.
- CWB_OK
- Successful Completion.
- CWB_NOT_ENOUGH_MEMORY
- Insufficient memory; may have failed to allocate temporary buffer.
- CWB_INVALID_POINTER
- Pointer to the list handle is NULL.
- CWBCO_NO_SUCH_ENVIRONMENT
- The specified environment does not exist.
- CWB_NON_REPRESENTABLE_UNICODE_CHAR
- One or more input Unicode characters have no representation in the codepage
being used.
- CWB_API_ERROR
- General API failure.
Usage
cwbCO_DeleteSysListHandle must
be called to free resources allocated with this API.