Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CancellationToken.Register Method (Action, Boolean)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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

public CancellationTokenRegistration Register(
	Action callback,
	bool useSynchronizationContext
)

Parameters

callback
Type: System.Action
The delegate to be executed when the CancellationToken is canceled.
useSynchronizationContext
Type: System.Boolean
A Boolean value that indicates whether to capture the current SynchronizationContext and use it when invoking the callback.

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.

Windows Phone OS

Supported in: 8.1, 8.0

Show: