|
Summary
The OnTransfer event fires the number of bytes transferred during file based transfer.
Description
The OnTransfer event occurs during a file based transfer of data from the local machine to a remote file or from the remote machine to a local file. The event contains the number of bytes of
data transferred between the two machines.
A file driven get, put, or append operation can be initiated by setting the FileAction property to FILE_ACTION_GET, FILE_ACTION_PUT, or FILE_ACTION_APPEND (or by calling the GetFile, PutFile or
AppendFile method) with the TransferMode property set to TRANSFER_MODE_FILE (or with the call to the FileMode method). The local file must be specified with the LocalFile property and the remote file
must be specified with the RemoteFile property. The TransferType property must be set to TRANSFER_TYPE_ASCII or TRANSFER_TYPE_BINARY (or the Ascii or Binary method must be called).
This event will be fired only if the Notify property is set to True. If the Notify property is set to False, then no OnTransfer events will occur.
As the file transfer proceeds, one or more OnTransfer events will occur to deliver the number of bytes transferred so far between the FTP server and the client. The application can process this data
and display the status of the file transfer (for example, update a progress bar or text control).
While handling the OnTransfer event, an application should not perform tasks, which have the potential of requiring a lot of time to complete, such as generating a message box.
Example
Sub FTPClient_OnTransfer (BytesCopied As Long)
Label.Caption = Str$(BytesCopied) & " transferred"
End Sub
See Also
The Notify property
| 
