|
Summary
Notifies that more data, during an event based transfer, has been received.
Description
The OnReceive event occurs during an event based transfer of a remote file to the local machine. An event driven get operation is started by calling the GetFile method (or by setting the
FileAction property to FILE_ACTION_GET) and calling the EventMode method (or with the TransferMode property set to TRANSFER_MODE_EVENT). The remote file must be specified with the RemoteFile
property, but the LocalFile property is ignored and can be left blank.
Instead of writing incoming data from the remote file directly to a local file, an event based get operation delivers the data in segments to the application with one or more OnReceive events. The
event passes data to the application in a string buffer. It is up to the application to process the data. The buffer could, for example, be written to a disk file, sent to another application using
DDE, copied into the clipboard or scanned for the desired information and then discarded.
If the application does not want to receive any more OnReceive events, then the transfer can be aborted by setting the FileAction property to FILE_ACTION_ABORT (or by calling the AbortFile method)
during the OnReceive event.
While handling the OnReceive 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. A substantial delay
could cause the application to not receive subsequent OnReceive events.
Example
Sub FTPGet ()
FTPClient.UseVariant = False
FTPClient.EventMode()
FTPClient.GetFile ("test.exe", "")
End Sub
' OnReceive event fired to deliver data
Sub FTPClient_OnReceive (Buffer As String)
Listing.AddItem Buffer
End Sub
Note
The EventMode() method must be called before calling the GetFile() method.
See Also
OnReceiveB
| 
