This structure is used by the GetTransferStatus method to
return information about a file transfer in progress.
typedef struct _FTPTRANSFERSTATUS
{
DWORD dwBytesTotal;
DWORD dwBytesCopied;
DWORD dwBytesPerSecond;
DWORD dwTimeElapsed;
DWORD dwTimeEstimated;
TCHAR szLocalFile[FTP_MAXFILENAMELEN];
TCHAR szRemoteFile[FTP_MAXFILENAMELEN];
} FTPTRANSFERSTATUS, *LPFTPTRANSFERSTATUS;
Members
- dwBytesTotal
- The total number of bytes that will be transferred. If the file
is being copied from the server to the local host, this is
the size of the remote file. If the file is being copied from the
local host to the server, it is the size of the local file.
If the file size cannot be determined, this value will be
zero.
- dwBytesCopied
- The total number of bytes that have been copied.
- dwBytesPerSecond
- The average number of bytes that have been copied per
second.
- dwTimeElapsed
- The number of seconds that have elapsed since the file transfer
started.
- dwTimeEstimated
- The estimated number of seconds until the file transfer is
completed. This is based on the average number of bytes transferred
per second.
- szLocalFile
- A pointer to a string which specifies the local file that is
being copied to or from the server.
- szRemoteFile
- A pointer to a string which specifies the remote file that
is being copied to or from the local system.
Remarks
If the option FTP_OPTION_HIRES_TIMER has been specified when connecting
to the server, the values returned in the dwTimeElapsed and
dwTimeEstimated members will be in milliseconds instead of
seconds. You can use this option to obtain more accurate elapsed times
when uploading or downloading small files over a fast network
connection.
If you are uploading or downloading large files which exceed 4GB,
you should use the FTPTRANSFERSTATUSEX structure which uses 64-bit
integers for the file size.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
See Also
GetTransferStatus,
FTPTRANSFERSTATUSEX
|