Version 4.5.2
 —  Programmierschnittstelle (API)  —

Übersicht der API-Aufrufe

Dieser Abschnitt enthält einen Überblick über alle verfügbaren API-Aufrufe. Sie sind in die folgenden funktionalen Bereiche aufgeteilt:

Diese API-Aufrufe (und alle damit verbundenen Ereignisse) sind nachstehend ausführlich beschrieben.


Initialisierung

Beim Starten einer Session kann der API-Client entweder die Verbindung zu einem aktiven Terminal herstellen oder ein neues Terminal erstellen.

Beginn der Anweisungsliste Session-Namen aller aktiven Terminals abfragen (nur synchroner Aufruf)

Beginn der Anweisungsliste Verbindung zu einem Terminal herstellen

Beginn der Anweisungsliste Bei Entire Connection anmelden

Seitenanfang

Session öffnen

Der API-Client kann entweder die zur Verfügung stehenden Session-Namen aus der Share-Datei abfragen oder eine namentlich bekannte Session direkt öffnen.

Beginn der Anweisungsliste Alle Sessions abfragen, die für einen Benutzer von Entire Connection definiert sind

Beginn der Anweisungsliste Eine dieser Sessions öffnen

Hiermit verbundene Ereignisse:

Seitenanfang

Allgemeine Steuerung

Beginn der Anweisungsliste Befehle an die geöffnete Session senden

Beginn der Anweisungsliste Beliebigen Text und Tasten-Codes senden

Beginn der Anweisungsliste Datenbenachrichtigungen erlauben (nur synchroner Aufruf) 

Beginn der Anweisungsliste Anzeige des Terminal-Fensters ein- und ausschalten

Hiermit verbundene Ereignisse:

Seitenanfang

Bildschirmdaten

Bildschirmtext steht als Rohtext zur Verfügung wie er vom Host empfangen wird und als verarbeiteter Text wie er im Terminal angezeigt wird. Der Rohtext enthält alle Zeichen - auch die, die nicht angezeigt werden sollen (z.B. Passwort) - und kann auch Nullwerte enthalten.

Da der Rohtext Nullwerte enthalten kann, kann er nur in ein Array mit vorzeichenlosen Zeichen ausgegeben werden. Der Bildschirmtext wird in ein Array mit Zeichenketten ausgegeben.

Beginn der Anweisungsliste Bildschirmtext abfragen

Beginn der Anweisungsliste Rohdaten abfragen

Beginn der Anweisungsliste Bildschirmattribute abfragen

Beginn der Anweisungsliste Erweiterte Bildschirmattribute abfragen

Beginn der Anweisungsliste Aktuelle Cursor-Position ermitteln und verändern

Beginn der Anweisungsliste Editierbaren Text im angegebenen Bereich entfernen

Beginn der Anweisungsliste IF-Befehl zum Suchen von Bildschirmtext aufrufen

Seitenanfang

Datentransfer

Beginn der Anweisungsliste Datentransfer vorbereiten für den direkten Transfer mit dem API-Client

Beginn der Anweisungsliste Dateiname vordefinieren

Beginn der Anweisungsliste Dateiname übergeben

Beginn der Anweisungsliste Laufenden Datentransfer abbrechen

Hiermit verbundene Ereignisse:

Seitenanfang

Tasks und Prozedurdateien

Beginn der Anweisungsliste Task oder Prozedurdatei ausführen

Beginn der Anweisungsliste Auf die globalen Parameter +PARM0 bis +PARM9 zugreifen

Beginn der Anweisungsliste Prozedurdatei abbrechen (nur synchroner Aufruf)

Hiermit verbundene Ereignisse:

Seitenanfang

Session beenden

Beginn der Anweisungsliste Geöffnete Session beenden, aber die Verbindung mit Entire Connection bestehen lassen

Beginn der Anweisungsliste Alle Terminals schließen (nur asynchroner Aufruf)

Beginn der Anweisungsliste Verbindung mit dem Terminal beenden (nur synchroner Aufruf)

Hiermit verbundene Ereignisse:

Seitenanfang

Andere Methoden

Beginn der Anweisungsliste Aktuelle Größe des geöffneten Terminals ermitteln

Seitenanfang