:Cancel()
Class
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 Error can be retrieved in the :nErr and :cErr Variables.
Description
|
|
The Method :Cancel() Cancels the current blocking operation, causing the blocking function to fail. |
|
|
|
|
|
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