IDTSEvents.OnQueryCancel Method
Called at any juncture in task processing where it is feasible to cancel execution. This event is raised by tasks and containers to determine whether they should stop running.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Function OnQueryCancel As Boolean
'Usage
Dim instance As IDTSEvents
Dim returnValue As Boolean
returnValue = instance.OnQueryCancel()
bool OnQueryCancel()
bool OnQueryCancel()
abstract OnQueryCancel : unit -> bool
function OnQueryCancel() : boolean
Return Value
Type: System.Boolean
A Boolean that indicates if the task should stop running.
Remarks
This event is called by the task to determine if the package wishes the task to cease executing. Because the package gives control to the task to execute and does not terminate tasks randomly, there needs to be a juncture at which the package may inform the task that it is attempting to shut down. If the value is true, the task should shut down and a cancelled message is returned from the Execute method of the task. If the value is false, the task continues to run as usual.