Purpose
Get the name of the connected system corresponding
to the index.
Syntax
unsigned int CWB_ENTRY cwbCO_GetConnectedSysName(
char *systemName,
unsigned long *bufferSize,
unsigned long index);
Parameters
- char *systemName - output
- Pointer to a buffer that will contain the system name. This buffer should
be large enough to hold at least CWBCO_MAX_SYS_NAME + 1 characters, including
the terminating NULL character.
- unsigned long * bufferSize - input/output
-
- input
- Size of the buffer pointed to by *systemName.
- output
- Size of buffer needed.
- unsigned long index
- Indicates which connected system to retrieve the name for. The first connected
system's index is 0, the second index is 1, and so on.
Return Codes
The following list shows common return
values.
- CWB_OK
- Successful Completion.
- CWB_INVALID_POINTER
- Pointer to system name or pointer to buffer size needed is NULL. Check
messages in the History Log to determine which are NULL.
- CWB_BUFFER_OVERFLOW
- Not enough room in output buffer to hold entire system name. Use *bufferSize
to determine the correct size. No error message is logged to the History
Log since the caller is expected to recover from this error and continue.
- CWBCO_END_OF_LIST
- The end of connected system list has been reached. No system name was
returned.
- CWB_NOT_ENOUGH_MEMORY
- Insufficient memory; may have failed to allocate temporary buffer.
- CWB_API_ERROR
- General API failure.
Usage
Connections for which system names can be
retrieved are those within the current process only.