Retrieving the status of a transfer

Description

Use the Status property to determine whether a transfer is active or it is already finished with success or error. This can be useful in combination with asynchronous commands or during an interactive script. The Status property will return a string.

Syntax

String Object.Status (long taskIdx)

Parameters

TaskIdx

This is the task index in the array of tasks created by asynchronous methods [0.. AsyncTaskNumber or - 1 (last started)]

Return Values

"WAIT"	Transfer action invoked but not initiated yet (followed by connecting)
"CANCELED"	Active transfer canceled by user
"FINISHED"	Transfer completed
"ERROR"	Error in transfer (any possible client or server error)
"SUSPENDED"	Added to queue but no transfer initiated yet
"SCHEDULED"	Item is scheduled for future transfer
"BLOCKED"	An internal status used for navigation and does not pertain to active or pending transfers. You can cancel any transfer requests in BLOCKED status without any ill effects.
"CHILDWAIT"	Condition when transfer item is waiting for a dependant item to finish transferring (*)
"SKIPPED"	Transfer skipped by user or automatically per overwrite rules
"CONNECTING"	Connecting to server (status right after WAIT)
"CANCELLING"	Cancel initiated but not completely stopped yet
"WORKING"	After connecting but before transferring. Could be opening data connection, or setting REST params, etc.
"TRANSFERRING"	File transfer in progress
"UNKNOWN"	Another string was returned other than one of the above. The string was unrecognized.

Example

Set MySite = CreateObject("CuteFTPPro.TEConnection")

If not CBool(MySite.IsPending) Then

MsgBox "Task done, final status is " + MySite.Status

End if