cwbRC_StartSysEx

Purpose

This function starts a conversation with the specified system. If the conversation is successfully started, a handle is returned. Use this handle with all subsequent calls to issue commands or call programs. When the conversation no longer is needed, use the handle with the cwbRC_StopSys API to end the conversation. The cwbRC_StartSysEx API may be called multiple times within an application. If the same system object handle is used on StartSysEx calls, only one conversation with the iSeries™ server will be started. If you want multiple conversations to be active, you must call StartSysEx multiple times, specifying different system object handles.

Syntax

 
unsigned int CWB_ENTRY cwbRC_StartSysEx(
                             const cwbCO_SysHandle systemObj,
                             cwbRC_SysHandle    *request);

Parameters

const cwbCO_SysHandle systemObj - input

Handle to an existing system object of the system on which you want programs and commands to be run.

cwbRC_SysHandle *request - output

Pointer to a cwbRC_SysHandle where the handle of the command request will be returned.

Return Codes

The following list shows common return values:

CWB_OK

Successful completion.

CWB_COMMUNICATIONS_ERROR

A communications error occurred.

CWB_SERVER_PROGRAM_NOT_FOUND

iSeries application not found.

CWB_HOST_NOT_FOUND

iSeries system inactive or does not exist.

CWB_SECURITY_ERROR

A security error has occurred.

CWB_LICENSE_ERROR

A license error has occurred.

CWB_CONFIG_ERROR

A configuration error has occurred.

CWBRC_SYSTEM_NAME

System name is too long.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory; may have failed to allocate temporary buffer.

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

None.