Méthode IDTSEvents100.OnQueryCancel
Cette API prend en charge l'infrastructure SQL Server 2012 et n'est pas destinée à être utilisée directement à partir de votre code.
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.
Espace de noms : Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly : Microsoft.SqlServer.DTSRuntimeWrap (en Microsoft.SqlServer.DTSRuntimeWrap.dll)
Syntaxe
'Déclaration
Sub OnQueryCancel ( _
<OutAttribute> ByRef pbCancel As Boolean _
)
'Utilisation
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
)
Paramètres
- pbCancel
Type : System.Boolean%
true to cancel the query; otherwise, false.
Notes
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.