OCX Control auf Windows-Systemen

Die OCX-Steuerung von openFT (Windows) bietet Ihnen die Möglichkeit, über Standardschnittstellen (OLE/COM) von Anwendungsprogrammen synchrone Datenübertragungsanforderungen auszuführen. Dies hat den Vorteil, dass Sie sofort ein Ergebnis geliefert bekommen, um über die anschließende Vorgehensweise zu entscheiden.
Die Steuerung bietet folgende Vorteile:

• Integration in die Systemarchitektur von Microsoft.

• Einfache Programmierschnittstelle für den Benutzer, die auf das Betriebssystem zugeschnitten ist.

• Ausführung von Datenübertragungsanforderungen von Standardprogrammen (wie Visual Basic) aus.

• Integration der openFT-Fortschrittsanzeige in Anwendungsprogramme.

Beachten Sie bitte, dass das OCX Control zu einem Zeitpunkt nur in einem Thread ausgeführt werden kann.
Die folgenden Tabellen beschreiben die Schnittstelle.

Allgemeine und optionale Merkmale

Merkmal	Datentyp	Beschreibung
Account	BSTR	Gibt die Kontonummer in der Syntax des fernen Systems an.
Compression	boolean	Gibt an, dass Abläufe mit gleichen Zeichenfolgen in komprimierter Form übertragen werden. Diese Option kann für FTAM-Partner nicht ausgewählt werden. Der Standardwert ist FALSE (FALSCH).
Encryption	boolean	Die Daten der zu übertragenden Datei werden für die Übertragung verschlüsselt. Diese Option kann für FTAM-Partner nicht ausgewählt werden. Der Standardwert ist FALSE (FALSCH).
FilePassword	BSTR	Wenn eine bestehende Datei überschrieben werden soll und diese Datei auf dem fernen System mit einem Kennwort geschützt ist, kann das Kennwort hier eingegeben werden.
FileType	BSTR	Gibt den zu übertragenden Dateityp an. Mögliche Werte: t: Text; Standardwert u: User Format (Benutzerformat, nicht für FTP-Partner) b: Binary (Binär)
LocalFile	BSTR	Der Name und, falls erforderlich, der Verzeichnispfad der Datei, die an das ferne System übertragen oder vom fernen System empfangen wird.
MaxRecordLength	BSTR	Hier kann die maximale Satzlänge für Dateien angegeben werden, die als Text- oder als Binärdateien mit einer Satzstruktur übertragen werden sollen.
Partner	BSTR	Partnername des fernen Systems.
Password	BSTR	Gibt das Kennwort in der Syntax des fernen Systems an.
RemoteFailureProc	BSTR	Dieser Befehl wird im fernen System ausgeführt, wenn die Datenübertragung fehlschlägt. Diese Option kann für FTAM- oder FTP-Partner nicht ausgewählt werden.
RemoteFile	BSTR	Der Dateiname kann als absoluter Pfadname oder relativ zum Login-Verzeichnis im fernen System angegeben werden.
RemoteSuccessProc	BSTR	Dieser Befehl wird im fernen System ausgeführt, wenn die Datenübertragung erfolgreich abgeschlossen wird. Diese Option kann für FTAM- oder FTP-Partner nicht ausgewählt werden.
ShowProgressInfo	boolean	Gibt an, ob die Fortschrittsleiste angezeigt werden soll. Der Standardwert ist TRUE (WAHR).
TransferAdmission	BSTR	Die Zugangsberechtigung von FTAC, wenn die Benutzer-Id im fernen System durch FTAC geschützt ist.
Transparent	boolean	Diesen Modus nur auswählen, wenn eine Datei aus einem BS2000-System mit den zugeordneten Merkmalen auf dem Computer gespeichert und später mit den zugeordneten Merkmalen wieder auf das BS2000-System zurückübertragen werden soll. Diese Option kann für FTAM- oder FTP-Partner nicht ausgewählt werden. Der Standardwert ist FALSE (FALSCH).
UserID	BSTR	Gibt die Benutzer-Id in der Syntax des fernen Systems an.
WriteMode	BSTR	Gibt an, ob eine bestehende Zieldatei überschrieben oder erweitert werden soll oder unverändert bleiben soll. Mögliche Werte: o: Overwrite (Überschreiben); Standardwert e: Extend (Erweitern) n: No Overwriting (Keine Überschreibung)

Optionale FTAM-Merkmale

Merkmal	Datentyp	Beschreibung
AccessMode	BSTR	Legt die Zugriffsberechtigung für die Datei fest, wenn die Sicherheitsgruppe auf dem fernen System verfügbar ist. Die Option ist verfügbar, wenn ein FTAM-Partner angegeben wurde. Werte: [r][i][p][x][e][a][c][d] | @rw | @ro. Standardwert: Die Standardwerte der FTAM-Partner finden Anwendung.
AccountNumber	BSTR	Die Speichergebühren für die Datei werden dem FTAM-Partner auf diesem Konto in Rechnung gestellt.
Availability	BSTR	Definiert die Verfügbarkeit der Empfangsdatei, wenn die Sicherheitsgruppe im fernen System verfügbar ist. Diese Option ist verfügbar, wenn ein FTAM-Partner angegeben wurde. Mögliche Werte: i: Immediate (Direkt); Standardwert d: Deferred (Verzögert)
CreationPassword	BSTR	Wenn ein Kennwort erforderlich ist, um eine Datei auf einem fernen System zu erstellen, muss das Kennwort an dieser Stelle angegeben werden. Die Option ist verfügbar, wenn ein FTAM-Partner angegeben wurde.
LegalQualification	BSTR	Definiert eine Berechtigung (entsprechend einem Copyright) für die Datei. Die Option ist verfügbar, wenn ein FTAM-Partner angegeben wurde.

Methoden

CancelSyncTransfer	---	Bricht die laufende Übertragung ab.
Erklärung:	long CancelSyncTransfer(BSTR* Nachricht);
Argumente:	[OUT] Nachricht:	Das Ergebnis ist nur Text.
Rückgabewert:	< 0:	Siehe Anmerkung unten.
	0:	Die Funktion wurde erfolgreich ausgeführt.
CancelSyncTransferV	---	Bricht die laufende Übertragung ab. Die Funktion ist identisch mit CancelSyncTransfer, jedoch ist das Argument vom Typ VARIANT* und ermöglicht so einen Aufruf aus VBScript.
Erklärung:	long CancelSyncTransferV (VARIANT* Nachricht);
Argumente:	[OUT] Nachricht:	Das Ergebnis ist nur Text (VARTYPE = VT_BSTR).
Rückgabewert:	< 0:	Siehe Anmerkung unten.
	0:	Die Funktion wurde erfolgreich ausgeführt.
IsSyncRunning	---	Überprüft, ob aktuell eine synchrone Übertragung durchgeführt wird.
Erklärung:	boolean IsSyncRunning();
Rückgabewert:	Falsch:	Momentan wird keine Übertragung ausgeführt.
	Wahr:	Momentan wird eine Übertragung ausgeführt.
ReceiveFileSync	---	Empfängt eine Datei vom Partnersystem.
Erklärung:	long ReceiveFileSync (BSTR* Nachricht);
Argumente:	[OUT] Nachricht:	Das Ergebnis ist reiner Text.
Rückgabewert:	< 0:	Siehe Anmerkung unten.
	0:	Die Funktion wurde erfolgreich ausgeführt.
	> 0:	Fehler, siehe Handbuch "openFT (Unix- und Windows-Systeme) - Kommandoschnittstelle"
ReceiveFileSyncV	---	Empfängt eine Datei vom Partnersystem. Die Funktion ist identisch mit ReceiveFileSync, jedoch ist das Argument vom Typ VARIANT* und ermöglicht so einen Aufruf aus VBScript.
Erklärung:	long ReceiveFileSyncV (VARIANT* Nachricht);
Argumente:	[OUT] Nachricht:	Das Ergebnis ist reiner Text (VARTYPE = VT_BSTR).
Rückgabewert:	< 0:	Siehe Anmerkung unten.
	0:	Die Funktion wurde erfolgreich ausgeführt.
	> 0:	Fehler, siehe Handbuch "openFT (Unix- und Windows-Systeme) - Kommandoschnittstelle"
SendFileSync	---	Sendet eine Datei an das Partnersystem.
Erklärung:	long SendFileSync (BSTR* Nachricht);
Argumente:	[OUT] Nachricht:	Das Ergebnis ist reiner Text.
Rückgabewert:	< 0:	Siehe Anmerkung unten.
	0:	Die Funktion wurde erfolgreich ausgeführt.
	> 0:	Fehler, siehe Handbuch "openFT (Unix- und Windows-Systeme) - Kommandoschnittstelle"
SendFileSyncV	---	Sendet eine Datei an das Partnersystem. Die Funktion ist identisch mit SendFileSync, jedoch ist das Argument vom Typ VARIANT* und ermöglicht so einen Aufruf aus VBScript.
Erklärung:	long SendFileSyncV (VARIANT* Nachricht);
Argumente:	[OUT] Nachricht:	Das Ergebnis ist reiner Text (VARTYPE = VT_BSTR).
Rückgabewert:	< 0:	Siehe Anmerkung unten.
	0:	Die Funktion wurde erfolgreich ausgeführt.
	> 0:	Fehler, siehe Handbuch "openFT (Unix- und Windows-Systeme) - Kommandoschnittstelle"

Bedeutung von negativen Rückgabewerten:
FT_SEQERR (-4):

Folgefehler. Die Funktion wurde möglicherweise nicht im richtigen Kontext aufgerufen.

FT_BUSY (-3):

Die Funktion darf nicht aufgerufen werden, solange eine ausgeführte Funktion noch nicht abgeschlossen ist.

FT_PARERR (-2):

Fehleranzeige für Parameter.

FT_ERROR (-1)

Allgemeine Fehleranzeige.