GetStateVerbose

GetStateVerbose 1:

Returns detailed information on a specific transfer operation. This method can be used, for example, to check the progress of a file upload/download.

Syntax

METHOD GetStateVerbose : BOOL
VAR_INPUT
    fbFtpConnection : REFERENCE TO FB_FtpConnection;
    nTransferHandle : UDINT;
END_VAR
VAR_OUTPUT
    stTransferStateVerbose : ST_FtpTransferStateVerbose;
END_VAR

GetStateVerbose 2: Return value

Name

Type

Description

GetStateVerbose

BOOL

Returns TRUE when the method has completed. Whether the action was successful can be read from the bError variable of the function block.

stTransferStateVerbose

ST_FtpTransferStateVerbose

Contains detailed information on the transfer operation.

GetStateVerbose 3: Inputs

Name

Type

Description

fbFtpConnection

FB_FtpConnection

References the server connection to be used for the operation.

nTransferHandle

UDINT

TransferHandle of the transfer operation.