Export (0) Print
Expand All

CancellationToken.Register Method (Action)

Registers a delegate that will be called when this CancellationToken is canceled.

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

member Register : 
        callback:Action -> CancellationTokenRegistration

Parameters

callback
Type: System.Action

The delegate to be executed when the CancellationToken is canceled.

Return Value

Type: System.Threading.CancellationTokenRegistration
The CancellationTokenRegistration instance that can be used to deregister the callback.

ExceptionCondition
ObjectDisposedException

The associated CancellationTokenSource has been disposed.

ArgumentNullException

callback is null.

If this token is already in the canceled state, the delegate will be run immediately and synchronously. Any exception the delegate generates will be propagated out of this method call.

The current ExecutionContext, if one exists, will be captured along with the delegate and will be used when executing it.

.NET Framework

Supported in: 4.5.2, 4.5.1, 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 8, Silverlight 8.1

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