CancellationTokenSource.Cancel Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Communicates a request for cancellation.
Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Sub Cancel
public void Cancel()
Exceptions
| Exception | Condition |
|---|---|
| ObjectDisposedException | This CancellationTokenSource has been disposed. |
| AggregateException | An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated CancellationToken. |
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 an 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.
Version Information
Silverlight
Supported in: 5
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
See Also