Dieses Dokument behandelt die folgenden Themen:
ServerRequestedFileName(ErrorCode, OpenFile, Flags, Title,
DefExtension, Filter, InitFileName, InitDirectory, FileName)
Wird aufgerufen, wenn die Session einen Dateinamen benötigt.
Die Parameter sind:
ErrorCode
|
Integer. Wird auf Null gesetzt, wenn der Dateiname angegeben wurde. |
FileName
|
String. Zu verwendender Dateiname. |
Die anderen Parameter sind die, die im Standarddateiauswahldialog angegeben werden können.
TerminalWarningMessage(Message, DisplayFlag)
Die Parameter sind:
Message
|
String. Anzuzeigende Nachricht. |
DisplayFlag
|
Boolean. Es wird erwartet, dass der Aufruf eine Nachricht in einem blockierenden Dialogfeld anzeigt (z.B. mit der Funktion MessageBox). |
Die folgende Tabelle enthält die Tasten-Codes, die mit PutData
übergeben werden können. Die erste Spalte enthält den Namen der Funktionstaste. In der zweiten Spalte steht die Konstante
für die Funktionstaste, so wie sie in der Include-Datei ECAPI.H definiert ist, und die dritte Spalte enthält den Wert des Tasten-Codes für die Funktionstaste.
Nur diese Tasten-Codes sollten verwendet werden. Wenn andere Werte übergeben werden, kann dies unvorhergesehene Folgen haben.
Die Include-Datei ECAPI.H ist als Bestandteil der Beispiele auf dem Installationsmedium von Entire Connection enthalten.
Funktionstaste | Definition des Tasten-Codes | Wert des Tasten-Codes |
---|---|---|
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 |
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 |
Alle Fehler-/Return-Codes sind Integer-Werte. Die unten aufgelisteten Konstanten sind in der Include-Datei ECAPI.H definiert. Die Zahlen in Klammern sind die eigentlichen Code-Werte.
Die Include-Datei ECAPI.H ist als Bestandteil der Beispiele auf dem Installationsmedium von Entire Connection enthalten.
API_SUCCESS (0)
Die meisten API-Funktionen geben
API_SUCCESS
zurück, wenn die Funktion erfolgreich war. Einige API-Funktionen haben einen spezifischen Return-Code im Erfolgsfall - siehe die 3 folgenden Funktionen.API_CALL_QUEUED (-1)
Dieser Return-Code wird im asynchronen (nicht-blockierenden) Modus benutzt. Er bedeutet, dass die Anforderung von der API-Anwendung erfolgreich an Entire Connection zur Bearbeitung übergeben wurde. Der eigentliche Return-Code für die Anforderung wird dann von Entire Connection in einem Ereignis (completion event) an die API-Anwendung gesendet.
API_NEW_SESSION_OPENED (-2)
Return-Code der API-Funktion
Initialize
, wenn eine neue Host-Session erfolgreich geöffnet wurde.API_PROC_CANCELLED_OK (-3)
Return-Code im Ereignis (completion event) für die API-Funktion
CancelRunningTask
, wenn die Prozedurdatei oder der Task erfolgreich abgebrochen wurde.API_ERROR_CALL_BLOCKED (1)
Dieser Return-Code wird intern benutzt. Er wird nicht an die API-Anwendung zurückgereicht.
API_ERROR_INCORRECT_PARAMETERS (2)
Alle API-Funktionen prüfen, ob die übergebenen Parameter gültig sind. Dieser Fehler-Code wird zurückgegeben, wenn die Parameter nicht gültig sind.
API_ERROR_NO_USER (10)
Dieser Fehler-Code wird von API-Funktionen zurückgegeben, die eine Host-Session benötigen, aber noch kein Benutzer in Entire Connection angemeldet ist. Bevor eine Host-Session geöffnet werden kann, muss ein Benutzer in Entire Connection angemeldet sein. Benutzen Sie die API-Funktion
LogonEntireConnection
zur Anmeldung.API_ERROR_NO_OPEN_SESSION (11)
Dieser Fehler-Code wird von API-Funktionen zurückgegeben, die auf einer Host-Session arbeiten, wenn noch keine Host-Session geöffnet wurde. Sie müssen erst eine Host-Session öffnen. Hierzu stehen die API-Funktionen
GetAvailableSessions
undOpenSession
zur Verfügung.API_ERROR_NO_FILE_TRANSFER (12)
Fehler-Code der API-Funktion
CancelFileTransfer
, wenn es keinen aktiven Datentransfer gibt.API_ERROR_NO_SESSIONS_DEFINED (13)
Fehler-Code der API-Funktion
GetAvailableSessions
, wenn für den angemeldeten Benutzer keine Sessions in der Share-Datei von Entire Connection definiert sind.API_ERROR_NO_SCREEN_PRESENT (14)
Fehler-Code der API-Funktion
GetScreenText
, wenn keine Bildschirmdaten vorhanden sind. Dies kann beim Öffnen der Session passieren, wenn der Host den ersten Bildschirm noch nicht geschickt hat.API_ERROR_NO_SESSION_NAME (15)
Fehler-Code der API-Funktion
OpenSession
, wenn kein Session-Name im ParameterSessionName
übergeben wurde.API_ERROR_NO_TASK_RUNNING (16)
Fehler-Code der API-Funktion
CancelRunningTask
, wenn kein aktiver Task oder keine aktive Prozedur vorhanden ist.API_ERROR_NOT_CONNECTED (20)
Dieser Fehler-Code wird von den API-Funktionen zurückgegeben, wenn das API-ActiveX-Control nicht mit Entire Connection verbunden ist. Zum Beispiel, weil Entire Connection vom Benutzer beendet wurde.
API_ERROR_ALREADY_CONNECTED (21)
Fehler-Code der API-Funktion
Initialize
, wenn die Funktion bereits vorher aufgerufen und erfolgreich durchgeführt wurde.API_ERROR_ALREADY_LOGGED_ON (22)
Fehler-Code der API-Funktion
LogonEntireConnection
, wenn der Benutzer bereits in Entire Connection angemeldet ist.API_ERROR_ALREADY_INITIALIZED (23)
Fehler-Code der API-Funktion
Initialize
, wenn das API-ActiveX-Control bereits mit Entire Connection verbunden ist.API_ERROR_SESSION_ALREADY_OPEN (24)
Fehler-Code der API-Funktion
OpenSession
, wenn bereits eine Host-Session geöffnet ist.API_ERROR_SESSION_NOT_FOUND (30)
Dieser Fehler-Code wird zur Zeit nicht benutzt.
API_ERROR_API_CALL_ONLY (31)
Dieser Fehler-Code wird in Entire Connection benutzt, wenn API-Funktionen aufgerufen werden, es aber keine aktive API-Anwendung gibt.
API_ERROR_INITIALIZATION_FAILED (40)
Fehler-Code der API-Funktion
Initialize
, wenn das API-ActiveX-Control nicht initialisiert oder nicht mit Entire Connection verbunden werden konnte.API_ERROR_CALL_FAILED (41)
Dieser Fehler-Code wird von den API-Funktionen zurückgegeben, wenn Entire Connection die Anforderung nicht erfolgreich durchführen konnte und keinen spezifischen Fehler-Code zurückgegeben hat.
API_ERROR_COMMS_ERROR (200)
Dieser Fehler-Code wird zur Zeit nicht benutzt.
API_ERROR_INTERNAL_ERROR (201)
Dieser Fehler-Code wird von den API-Funktionen zurückgegeben, wenn ein unerwarteter Fehler oder Ausnahmefehler aufgetreten ist. Die Anforderung wurde abgebrochen. Entire Connection ist vermutlich instabil. Starten Sie Entire Connection neu und versuchen Sie es noch einmal.