IDTSEvents100.OnQueryCancel-Methode

Diese API unterstützt die SQL Server 2012-Infrastruktur und ist nicht zur direkten Verwendung im Code bestimmt.

Indicates a 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.Wrapper
Assembly:  Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)

Syntax

'Declaration
Sub OnQueryCancel ( _
    <OutAttribute> ByRef pbCancel As Boolean _
)
'Usage
Dim instance As IDTSEvents100 
Dim pbCancel As Boolean

instance.OnQueryCancel(pbCancel)

void OnQueryCancel(
    out bool pbCancel
)

void OnQueryCancel(
    [OutAttribute] bool% pbCancel
)

abstract OnQueryCancel : 
        pbCancel:bool byref -> unit

function OnQueryCancel(
    pbCancel : boolean
)

Parameter

• pbCancel
  Typ: System.Boolean%
  true to cancel the query; otherwise, false.

Hinweise

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.

For more information, see IDTSEvents.

Siehe auch

Verweis

IDTSEvents100 Schnittstelle

Microsoft.SqlServer.Dts.Runtime.Wrapper-Namespace