DefaultEvents.OnQueryCancel Method

Article
12/03/2008

This method is 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
Public Overridable Function OnQueryCancel As Boolean

public virtual bool OnQueryCancel ()

public:
virtual bool OnQueryCancel ()

public boolean OnQueryCancel ()

public function OnQueryCancel () : boolean

Return Value

A Boolean that indicates if the task should stop running.

Remarks

This event is called by the task to determine if the package wants 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 can inform the task that it is attempting to shut down. If the value is true, the task should shut down and DTSER_CANCELED is returned from the Execute method of the task. If the value is false, the task continues to run as usual.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via