:Cancel()

Class

     aprFTP()

Syntax

     :Cancel( [hSession] ) --> lSuccess

Parameters

     hSession (optional)

           If hSession is not passed, the value in :Session will be used.

Return

Logical lSuccess indicating whether or not the Method was successful

If the Method fails the return value is .F.. To get further error information see :nErr and :cErr

Description

The :Cancel() method cancels any outstanding blocking operation in the client, causing the blocking method to fail. The application may then retry the operation or terminate the client session.

When the :Cancel() method is called, the blocking operation will not immediately fail. An internal flag is set which causes the blocking operation to exit with an error. This means that the application cannot cancel an operation and immediately perform some other operation. Instead it must allow the calling stack to unwind, returning back to the blocking operation before making any further function calls. 

See Also

:IsBlocking(), :Read(), :Reset(), :Write()