DkmWorkList.Cancel 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.
Overloads
| Cancel() |
Cancel execution of this work list. This API will return once all work on this work queue has stopped (worklist is canceled or completed). The request is ignored if the work list is already canceled. This method may only be called by the component which created the object. Note for components declared as 'Synchronized' in the component configuration: calling this API may implicitly release and then reacquire the lock around your component. Be mindful of possible state changes. |
| Cancel(Boolean) |
Cancel execution of this work list. The request is ignored if the work list is already canceled. This method may only be called by the component which created the object. This API was added in Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7) |
Cancel()
Cancel execution of this work list. This API will return once all work on this work queue has stopped (worklist is canceled or completed). The request is ignored if the work list is already canceled. This method may only be called by the component which created the object.
Note for components declared as 'Synchronized' in the component configuration: calling this API may implicitly release and then reacquire the lock around your component. Be mindful of possible state changes.
public:
void Cancel();public:
void Cancel();void Cancel();public void Cancel ();member this.Cancel : unit -> unitPublic Sub Cancel ()Applies to
Cancel(Boolean)
Cancel execution of this work list. The request is ignored if the work list is already canceled. This method may only be called by the component which created the object.
This API was added in Visual Studio 15 Update 7 (DkmApiVersion.VS15Update7)
public:
void Cancel(bool blockOnCompletion);public void Cancel (bool blockOnCompletion);member this.Cancel : bool -> unitPublic Sub Cancel (blockOnCompletion As Boolean)Parameters
- blockOnCompletion
- Boolean
Indicates whether to block on all queued tasks firing completion routines. If true, this API will return once all work on this work queue has stopped (worklist is canceled or completed). Note for components declared as 'Synchronized' in the component configuration: calling this API may implicitly release and then reacquire the lock around your component. Be mindful of possible state changes.
Otherwise this will begin cancellation and return without waiting for the work to be stopped.