|
|
| .NET Framework Class Library |
| CancellationTokenSource..::.Cancel Method (Boolean) |
| CancellationTokenSource Class See Also Send Feedback |
Namespace:
System.Threading
Assembly:
System.Threading (in System.Threading.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Public Sub Cancel ( _ throwOnFirstException As Boolean _ ) |
| C# |
|---|
public void Cancel( bool throwOnFirstException ) |
Parameters
- throwOnFirstException
- Type: System..::.Boolean
Specifies whether exceptions should immediately propagate.
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. If throwOnFirstException is true, an exception will immediately propagate out of the call to Cancel, preventing the remaining callbacks and cancelable operations from being processed. If throwOnFirstException is false, this overload 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. |
See Also
