IDTSEvents100.OnQueryCancel(Boolean) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
public:
void OnQueryCancel([Runtime::InteropServices::Out] bool % pbCancel);[System.Runtime.InteropServices.DispId(9)]
public void OnQueryCancel (out bool pbCancel);[<System.Runtime.InteropServices.DispId(9)>]
abstract member OnQueryCancel : bool -> unitPublic Sub OnQueryCancel (ByRef pbCancel As Boolean)Parameters
- pbCancel
- Boolean
true to cancel the query; otherwise, false.
- Attributes
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.
For more information, see IDTSEvents.