CancelProc Class Documentation

class CancelProc : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

A callback function used to abort an operation.

A CancelProc() value is typically passed to a method that uses it to determine if an asynchronous operation should be ended.

At periodic intervals, the method calls the CancelProc. If the CancelProc returns a "true" boolean value, the method cancels the operation. If CancelProc returns false, the method allows the operation to continue. For example, CancelProc could be used to allow a user to click a Cancel button to end a function.

Constructor & Destructor Documentation

CancelProc

CancelProc()

A callback function used to abort an operation.

A CancelProc() value is typically passed to a method that uses it to determine if an asynchronous operation should be ended.

At periodic intervals, the method calls the CancelProc. If the CancelProc returns a "true" boolean value, the method cancels the operation. If CancelProc returns false, the method allows the operation to continue. For example, CancelProc could be used to allow a user to click a Cancel button to end a function.

Member Function Documentation

Call

bool Call()

Returns:

bool

Dispose

void Dispose()

Returns:

void