Export (0) Print
Expand All

CancellationTokenSource.Cancel Method

Communicates a request for cancellation.

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

public void Cancel()

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.

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.

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft