Other Events, Key Codes and Return/Error Codes

This document covers the following topics:

Other Events

  • ServerRequestedFileName(ErrorCode, OpenFile, Flags, Title, DefExtension, Filter, InitFileName, InitDirectory, FileName)

    Is called if the session needs a file name.

    The parameters are:

    ErrorCode Integer. Is set to zero when the file name has been set.
    FileName String. The file name to be used.

    The other parameters are those expected by the common open file dialog.

  • TerminalWarningMessage(Message, DisplayFlag)

    The parameters are:

    Message String. Message to be displayed.
    DisplayFlag Boolean. The call is expected to show a message in a blocking dialog box (for example, using the MessageBox function).

Key Codes

The table below shows the key codes that can be passed using the PutData function. The first column contains the function key name. The second column contains the function key constant as it is defined in the include file ECAPI.H, and the third column contains the key code value for the function key. Only these values should be used. If other values are passed, the effects are not defined.

The include file ECAPI.H is provided on the Entire Connection installation medium as part of the samples.

Function Key Key Code Definition Key Code Value
PF1 EC_PF1 20
PF2 EC_PF2 21
PF3 EC_PF3 22
PF4 EC_PF4 23
PF5 EC_PF5 24
PF6 EC_PF6 25
PF7 EC_PF7 26
PF8 EC_PF8 27
PF9 EC_PF9 28
PF10 EC_PF10 29
PF11 EC_PF11 30
PF12 EC_PF12 31
PF13 EC_PF13 32
PF14 EC_PF14 33
PF15 EC_PF15 34
PF16 EC_PF16 35
PF17 EC_PF17 36
PF18 EC_PF18 37
PF19 EC_PF19 38
PF20 EC_PF20 39
PF21 EC_PF21 40
PF22 EC_PF22 41
PF23 EC_PF23 42
PF24 EC_PF24 43
ATTN EC_ATTN 46
CLEAR EC_CLEAR 16
CR EC_CR 13
DEVCNCL EC_DEVCNCL 50
EEOF EC_EEOF 54
ERASEINP EC_ERASEINP 44
INSERT EC_INSERT 82
NEWLINE EC_NEWLINE 48
PRINT EC_PRINT 49
SYSREQ EC_SYSREQ 47
HOME EC_HOME 71
PA1 EC_PA1 17
PA2 EC_PA2 18
PA3 EC_PA3 19
DELETE EC_DELETE 83
BACKSPACE EC_BACKSPACE 8
TAB EC_TAB 9
BACKTAB EC_BACKTAB 15
LEFT EC_LEFT 75
RIGHT EC_RIGHT 77
UP EC_UP 72
DOWN EC_DOWN 80
DUE2 EC_DUE2 56
EM EC__EM 84
AFZ EC_AFZ 11
EFZ EC_EFZ 165
LZE EC_LZE 89
RU EC_RU 163
SDZ EC_SDZ 160
SZA EC_SZA 85
K1 EC_K1 193
K2 EC_K2 194
K3 EC_K3 195

Return/Error Codes

The return/error codes are all integer values. The constants listed below are defined in the include file ECAPI.H. The numbers in parentheses are the actual code values.

The include file ECAPI.H is provided on the Entire Connection installation medium as part of the samples.

API_SUCCESS (0)

Returned from most functions if the operation was successful. Some functions have specific success return codes - see below.

API_CALL_QUEUED (-1)

This return code is used in asynchronous (non-blocking) mode. It means that the request from the API application has successfully been sent to Entire Connection for processing. The return code for the request from Entire Connection is passed in a completion event to the API application.

API_NEW_SESSION_OPENED (-2)

Returned by the Initialize API function if a new session has been created successfully.

API_PROC_CANCELLED_OK (-3)

Sent as completion event for the CancelRunningTask API function if the Entire Connection task or procedure file has been canceled successfully.

API_ERROR_CALL_BLOCKED (1)

This return code is used internally. It is not passed to the API application.

API_ERROR_INCORRECT_PARAMETERS (2)

Each API function checks whether the passed parameters are valid. If not, this error code is returned.

API_ERROR_NO_USER (10)

In order to use a terminal, a user has to log on to Entire Connection. This error code is returned if you called a function requiring a terminal but no user has logged on yet. Use the API function LogonEntireConnection to log on.

API_ERROR_NO_OPEN_SESSION (11)

This error code is returned by API functions that work on an open terminal session if there is no open terminal session. You first have to open a session, for example, with the API functions GetAvailableSessions and OpenSession.

API_ERROR_NO_FILE_TRANSFER (12)

The API function CancelFileTransfer returns this error code if there is no active file transfer.

API_ERROR_NO_SESSIONS_DEFINED (13)

The API function GetAvailableSessions returns this error code if no sessions are defined in the share file for the current user.

API_ERROR_NO_SCREEN_PRESENT (14)

The API function GetScreenText returns this error code if no screen data is available because the first screen from the host has not yet arrived.

API_ERROR_NO_SESSION_NAME (15)

The API function OpenSession returns this error code if no session name was passed in the parameter SessionName.

API_ERROR_NO_TASK_RUNNING (16)

The API function CancelRunningTask returns this error code if there is no active task or procedure.

API_ERROR_NOT_CONNECTED (20)

This error code is returned by the API functions if the API ActiveX control is not connected to Entire Connection. For example, if Entire Connection was manually closed by a user.

API_ERROR_ALREADY_CONNECTED (21)

The API function Initialize returns this error code when the function has already been called before and returned successfully.

API_ERROR_ALREADY_LOGGED_ON (22)

The API function LogonEntireConnection returns this error code if the user is already logged on to Entire Connection.

API_ERROR_ALREADY_INITIALIZED (23)

The API function Initialize returns this error code if the API ActiveX control is already attached to Entire Connection.

API_ERROR_SESSION_ALREADY_OPEN (24)

The API function OpenSession returns this error code if there already is an open session.

API_ERROR_SESSION_NOT_FOUND (30)

This return code is currently not used.

API_ERROR_API_CALL_ONLY (31)

This error code is used in Entire Connection if API functions are called but there is no active API application.

API_ERROR_INITIALIZATION_FAILED (40)

The API function Initialize returns this error code if the API ActiveX control could not be initialized or if it could not be attached to Entire Connection.

API_ERROR_CALL_FAILED (41)

This error code is used by the API functions if Entire Connection could not complete the requested operation successfully and it did not return a specific error code.

API_ERROR_COMMS_ERROR (200)

This return code is currently not used.

API_ERROR_INTERNAL_ERROR (201)

This error code is returned when an unexpected error or exception occurred. At least the requested operation was aborted, and failed. Entire Connection may be instable. Restart Entire Connection and retry.