Export (0) Print
Expand All

CancellationTokenSource.Cancel Method (Boolean)

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

Namespace:  System.Threading
Assemblies:   System.Threading.Tasks (in System.Threading.Tasks.dll)
  mscorlib (in mscorlib.dll)

'Declaration
Public Sub Cancel ( _
	throwOnFirstException As Boolean _
)

Parameters

throwOnFirstException
Type: System.Boolean

true if exceptions should immediately propagate; otherwise, false.

ExceptionCondition
ObjectDisposedException

This CancellationTokenSource has been disposed.

AggregateException

An aggregate exception containing all the exceptions thrown by the registered callbacks on the associated CancellationToken.

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 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.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft