Funktionsbausteine

 

FB_FtpClient

Übersicht

Typ

Funktionsbaustein

Verfügbar ab

V1.0.4.0

G-SE-0052533.1.gif-high.gif

 

 

Aufgabe

Der Funktionsbaustein FB_FtpClient umfasst die dazugehörigen FTP-Funktionen für Operationen an Dateien und Verzeichnissen. Jede Instanz behandelt eine FTP-Verbindung. Wenn Sie versuchen eine zweite Übertragung herzustellen, antwortet der Funktionsbaustein mit ET_Result.UnableToEstablishMutlipleConnections.

Funktionsbeschreibung

Der Funktionsbaustein FB_FtpClient ist die Benutzerschnittstelle, um mit dem externen FTP-Server zu interagieren.

Nachdem der Funktionsbaustein aktiviert wurde, wird eine FTP-Verbindung hergestellt, die die Benutzerinformationen verwendet die mithilfe iq_stCredentials übermittelt wurden. Sobald die Verbindung hergestellt wurde, ist der Funktionsbaustein in der Lage, von i_etCommand übermittelte Befehle und eine an i_xExecute erkannte steigende Flanke zu verarbeiten.

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 reaktivieren Sie den Funktionsbaustein, um den Befehl senden zu können.

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

Wenn eine Zeitüberschreitung nach Herstellung der Verbindung erreicht wurde, wird die Ausführung des nächsten FTP-Befehl (ET_FtpCommand) als Fehler erkannt. Um dieses Verhalten zu vermeiden, aktivieren Sie den Funktionsbaustein unmittelbar vor den entsprechenden Operationen und deaktivieren Sie ihn hinterher.

Schnittstelle

Eingang

Datentyp

Beschreibung

i_xEnable

BOOL

Aktivierung und Initialisierung des Funktionsbausteins

i_xExecute

BOOL

Der mit dem Eingang i_etCommand spezifizierte Befehl wird bei einer steigenden Flanke dieses Eingangs ausgeführt.

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

Verwendet, um die Struktur mit den Benutzereinstellungen wie Benutzername oder Passwort zu übermitteln.

iq_stContent

ST_Content

Verwendet, um das Arbeitsverzeichnis und, falls zutreffend, die Anzahl und Namen der Dateien in diesem Verzeichnis zu übermitteln.

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 ist, hat der Funktionsbaustein den in i_etCommand spezifizierten 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.