FB_FtpClient

Überblick

Typ:

Funktionsbaustein

Verfügbar ab:

V1.0.4.0

Aufgabe

FB_FtpClient ist für ungesicherte FTP-Verbindungen reserviert. Er enthält die entsprechenden FTP-Funktionen für Vorgänge mit Dateien und Verzeichnissen. Jede Instanz verarbeitet eine ungesicherte FTP-Verbindung. Wenn Sie versuchen, eine zweite Übertragung durchzuführen, antwortet der Funktionsbaustein mit ET_Result.UnableToEstablishMutlipleConnections.

Funktionsbeschreibung

Der Funktionsbaustein FB_FtpClient fungiert als Benutzerschnittstelle für die Interaktion mit dem externen FTP-Server über eine gesicherte Verbindung per TLS.

Nachdem der Funktionsbaustein aktiviert wurde, wird eine gesicherte FTP-Verbindung mithilfe der gesicherten Benutzeranmeldedaten hergestellt, die über iq_stCredentials übermittelt werden. Sobald die ungesicherte Verbindung hergestellt wurde, kann der Funktionsbaustein die über i_etCommand übermittelten Befehle verarbeiten und eine steigende Flanke an i_xExecute erkennen.

Solange Befehle ausgeführt werden, wird der Ausgang q_xBusy auf TRUE gesetzt. Nachdem ein Befehl erfolgreich abgeschlossen wurde, wird q_xDone auf TRUE gesetzt.

Statusmeldungen und Diagnoseinformationen werden unter Verwendung der Ausgänge q_xError (TRUE, wenn ein Fehler erkannt wurde), q_etResult und q_etResultMsg bereitgestellt.

Um erkannte Fehler zu bestätigen, deaktivieren und aktivieren Sie den Funktionsbaustein dann erneut, um einen Befehl senden zu können.

Wenn Sie den Funktionsbaustein (i_xEnable = FALSE) deaktivieren, muss dieser aufgerufen werden, solange q_xActive = TRUE, um die internen Bereinigungsvorgänge abzuschließen. Danach kann er wieder aktiviert werden.

Wenn nach Aufbau der Verbindung ein Timeout auftritt, wird die Ausführung des nächsten FTP-Befehls (ET_FtpCommand) als Fehler erkannt. Um dieses Verhalten zu vermeiden, aktivieren Sie den Funktionsbaustein unmittelbar vor den entsprechenden Operationen und deaktivieren Sie ihn anschließend.

Schnittstelle

Eingang

Datentyp

Beschreibung

i_xEnable

BOOL

Aktivierung und Initialisierung des Funktionsbausteins

Siehe Verhalten von Funktionsbausteinen mit dem Eingang i_xEnable und i_xExecute.

i_xExecute

BOOL

Der über den Eingang i_etCommand angegebene Befehl wird bei einer steigenden Flanke an diesem Eingang ausgeführt.

Siehe Verhalten von Funktionsbausteinen mit dem Eingang i_xEnable und i_xExecute.

i_etCommand

ET_FtpCommand

Der FTP-Befehl, der ausgeführt wird, wenn der Eingang i_xExecute TRUE ist.

Eingang/Ausgang

Datentyp

Beschreibung

iq_stCredentials

ST_Credentials

Dient der Übergabe der Struktur mit den Benutzereinstellungen wie Benutzername oder Passwort.

iq_stContent

ST_Content

Dient der Übergabe des Arbeitsverzeichnisses und, falls zutreffend, der Anzahl und Namen der Dateien in diesem Verzeichnis.

Ausgang

Datentyp

Beschreibung

q_xActive

BOOL

Wenn der Funktionsbaustein aktiv ist, wird der Ausgang auf TRUE gesetzt.

q_xReady

BOOL

Wenn die Initialisierung erfolgreich ist, wird der Ausgang auf TRUE gesetzt, solange der Funktionsbaustein in der Lage ist, Eingänge zu akzeptieren.

q_xBusy

BOOL

Wenn der Ausgang auf TRUE gesetzt ist, führt der Funktionsbaustein den in i_etCommand spezifizierten Befehl aus.

q_xDone

BOOL

Wenn der Ausgang auf TRUE gesetzt wird, hat der Funktionsbaustein den über i_etCommand angegebenen Befehl erfolgreich abgeschlossen.

q_xError

BOOL

Wenn dieser Ausgang auf TRUE gesetzt wird, wurde ein Fehler identifiziert. Für weitere Informationen siehe q_etResult und q_etResultMsg.

q_etResult

ET_Result

Gibt Diagnose- und Statusinformationen an.

q_sResultMsg

STRING[255]

Gibt zusätzliche Diagnose- und Statusinformationen an.