FB_FtpExplorer

FB_FtpExplorer 1:

This function block can be used to perform file and directory operations, e.g. creating new directories on the FTP server or reading existing directories. The corresponding operations are available as methods on the function block.

FB_FtpExplorer 2: Inputs

VAR_INPUT
    tTimeout : TIME;
    sNetID   : T_AmsNetID;
END_VAR

Name

Type

Description

tTimeout

TIME

Indicates the ADS timeout to be used between PLC runtime and the FTP client user mode process (in seconds).

sNetID

T_AmsNetID

AmsNetID of the device on which the FTP client user mode process is running. Normally, the FTP client and the PLC run on the same system, so no value needs to be assigned to this variable.

FB_FtpExplorer 3: Outputs

VAR_OUTPUT
    bError           : BOOL;
    ipResultMessage  : I_TcMessage;
    bBusy            : BOOL;
    eActiveOperation : E_FtpClientOperation;
END_VAR

Name

Type

Description

bError

BOOL

TRUE if an error has occurred.

ipResultMessage

I_TcMessage

Output with extended error and diagnostic information based on the TwinCAT 3 EventLogger.

bBusy

BOOL

TRUE as soon as the function block is in use.

eActiveOperation

E_FtpClientOperation

Indicates the current transfer operation.

FB_FtpExplorer 4: Methods

Name

Description

DirCreate

Creates a new directory.

DirExists

Checks whether a directory exists.

DirMove

Moves a directory.

DirRemove

Removes a directory.

DirRename

Renames a directory.

FileExists

Checks whether a file exists.

FileMove

Moves a file.

FileRemove

Removes a file.

FileRename

Renames a file.

Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT v3.1 Build 4026

PC or CX (x86)

Tc3_FTP