System.Threading.CancellationTokenSource.Cancel Method

Communicates a request for cancellation, and specifies whether remaining callbacks and cancelable operations should be processed.

Syntax

public void Cancel (bool throwOnFirstException)

Parameters

throwOnFirstException
true if exceptions should immediately propagate; otherwise, false.

Remarks

The associated System.Threading.CancellationToken will be notified of the cancellation and will transition to a state where CancellationToken.IsCancellationRequested returns true.

Any callbacks or cancelable operations registered with the System.Threading.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 CancellationTokenSource.Cancel(bool), preventing the remaining callbacks and cancelable operations from being processed.

If throwOnFirstException is false, this overload 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 System.Threading.ExecutionContext that was captured when each callback was registered will be reestablished when the callback is invoked.

Requirements

Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 4.0.0.0