CancelPendingOperation Method (ScheduleDataConnectorBase)

Cancels a pending operation.

Syntax

Visual Basic

'Declaration
 
Protected Friend MustOverride Function CancelPendingOperation( _
   ByVal operation As OperationResult _
) As CancelOperationResult

C#

protected internal abstract CancelOperationResult CancelPendingOperation( 
   OperationResult operation
)

Parameters

operation

Pending operation that is to be canceled.

Return Value

True to indicate that the operation was successfull, False otherwise.

Remarks

CancelPendingOperation method is called to cancel a pending operation. It's only valid for operations that are still pending, that is their Infragistics.OperationResult.IsComplete is false.

An example of how this method is used is as follows. GetActivities method returns ActivityQueryResult object. The activities can be retrieved asynchronously. Before the activities are retrieved, there may be a need for canceling the operation. For example, the user scrolls the schedule control to a different range of dates in which case it's not necessary to retrieve activities for the perviously visible date range. In such a case, the previous query operation will be canceled if it's still pending.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2