:GetTransferStatus()
Class
Syntax
:GetTransferStatus( [hSession] ) -> aStatus
Parameters
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
A seven element array containing the Transfer Status information.
|
Value |
Constant |
Description |
|
1 |
FTP_TOTAL_BYTES |
The total number of bytes that will be transferred. If the file is being copied from the remote system to the local host, this is the size of the remote file. If the file is being copied from the local host to the remote system, it is the size of the local file. If the file size cannot be determined, this value will be zero. |
|
2 |
FTP_BYTES_COPIED |
The total number of bytes that have been copied. |
|
3 |
FTP_BYTES_PER_SECOND |
The average number of bytes that have been copied per second. |
|
4 |
FTP_ELAPSED_TIME |
The number of seconds that have elapsed since the file transfer started. |
|
5 |
FTP_ESTIMATED_TIME |
The estimated number of seconds until the file transfer is completed. This is based on the average number of bytes transferred per second. |
|
6 |
FTP_LOCAL_FILENAME |
Local file that is being copied to or from the remote system. |
|
7 |
FTP_REMOTE_FILENAME |
Remote file that is being copied to or from the local system. |
Description
The :GetTransferStatus() method returns information about the current file transfer, including the average number of bytes transferred per second and the estimated amount of time until the transfer completes. If there is no file currently being transferred, this function will return the status of the last successful transfer made by the client.
See Also
:GetFileStatus(), :GetTransferTime(), :GetBytesCopied()