.NET Framework Class Library |
CancellationTokenSource..::.Cancel Method |
CancellationTokenSource Class See Also Send Feedback |
Namespace:
System.Threading
Assembly:
System.Threading (in System.Threading.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Sub Cancel |
C# |
---|
public void Cancel() |
Remarks
The associated CancellationToken will be notified of the cancellation and will transition to a state where IsCancellationRequested returns true. Any callbacks or cancelable operations registered with the CancellationToken will be executed.
Cancelable operations and callbacks registered with the token should not throw exceptions. However, this overload of Cancel will aggregate any exceptions thrown into a AggregateException, such that one callback throwing an exception will not prevent other registered callbacks from being executed.
The ExecutionContext that was captured when each callback was registered will be reestablished when the callback is invoked.
Exceptions
Exception | Condition |
---|---|
System..::.AggregateException | An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated CancellationToken. |
System..::.ObjectDisposedException | This CancellationTokenSource has been disposed. |