GetState
Returns the current state of a specific transfer operation. This method can be used, for example, to check the progress of a file upload/download.
Syntax
METHOD GetState : BOOL
VAR_INPUT
fbFtpConnection : REFERENCE TO FB_FtpConnection;
nTransferHandle : UDINT;
END_VAR
VAR_OUTPUT
stTransferState : ST_FtpTransferState;
END_VAR
Return value
Name | Type | Description |
|---|---|---|
GetState | BOOL | Returns TRUE when the method has completed. Whether the action was successful can be read from the bError variable of the function block. |
stTransferState | Contains the state information for the transfer operation. |
Inputs
Name | Type | Description |
|---|---|---|
fbFtpConnection | References the server connection to be used for the operation. | |
nTransferHandle | UDINT | TransferHandle of the transfer operation. |