CancellationToken.Register Method (Action, Boolean)
Registers a delegate that will be called when this CancellationToken is canceled.
Assembly: mscorlib (in mscorlib.dll)
Public Function Register ( callback As Action, useSynchronizationContext As Boolean ) As CancellationTokenRegistration
Parameters
- callback
-
Type:
System.Action
The delegate to be executed when the CancellationToken is canceled.
- useSynchronizationContext
-
Type:
System.Boolean
A value that indicates whether to capture the current SynchronizationContext and use it when invoking the callback.
Return Value
Type: System.Threading.CancellationTokenRegistrationThe CancellationTokenRegistration instance that can be used to deregister the callback.
| Exception | Condition |
|---|---|
| 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.
If useSynchronizationContext is true, the current ExecutionContext, if one exists, will be captured along with the delegate and will be used when executing it.
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 5.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1