Método IDTSEvents100.OnQueryCancel
Essa API oferece suporte à infraestrutura do SQL Server 2012 e não se destina a ser usada diretamente no seu código.
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 (em Microsoft.SqlServer.DTSRuntimeWrap.dll)
Sintaxe
'Declaração
Sub OnQueryCancel ( _
<OutAttribute> ByRef pbCancel As Boolean _
)
'Uso
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
)
Parâmetros
- pbCancel
Tipo: System.Boolean%
true to cancel the query; otherwise, false.
Comentários
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.