|
Summary
Abort file transfer in progress.
Syntax
Boolean AbortFile ()
Description
The AbortFile method aborts a file transfer in progress. This method aborts any get, put, or append operation in progress. This is usually done during an OnSend or OnReceive event to make
sure that no further such events will occur.
The AbortFile method takes no parameters and returns a boolean. If the get, put, or append operation in progress is successfully aborted, 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 FileAction property to FILE_ACTION_ABORT.
Example
Result = FTPClient.AbortFile () If Result = False Then MsgBox "Unable to abort file transfer", 64, "Sample Program" End If
|