|
Summary
Set transfer mode to event based transfer.
Syntax
Boolean EventMode ()
Description
The EventMode method sets the file transfer mode to event based. This means that one or more OnSend events (in case of a put or append operation) or one or more OnReceive events (in case of a
get operation) will be fired. An OnSend event asks the application to provide up to a maximum number of bytes of data, which are to be saved in the remote file. OnSend events are generated until the
application indicates that there is no more data to send. An OnReceive event delivers a portion of the data from the remote file to the application. Event based file transfer allows an application to
move data to and from storage other than the local disk, such as through DDE or the clipboard.
The EventMode method takes no parameters and returns a boolean. If the transfer mode can be successfully set to event mode file transfer, then the method returns True; otherwise, it returns False.
The application should ensure that the method was successfully executed by checking the return value. The method also sets the LastResult property. The value of the LastResult property can be checked
to determine if any error occurred.
Calling this method is equivalent to setting the TransferMode property to TRANSFER_MODE_EVENT.
This method can be called at any time except during a file transfer.
Note
Event based mode gives you greater control over the file transfer. I fhte data you wish to transfer is not currently in a file, yu should use an event based file transfer. Recovery following a failed
transfer is only supported in an event based transfer.
Example
Result = FTPClient.EventMode ()
|