Export (0) Print
Expand All

CancellationToken.Register Method (Action<Object>, Object)

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

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

public CancellationTokenRegistration Register(
	Action<Object> callback,
	Object state
)

Parameters

callback
Type: System.Action<Object>

The delegate to be executed when the CancellationToken is canceled.

state
Type: System.Object

The state to pass to the callback when the delegate is invoked. This may be null.

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