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(Of Object), Object)
.NET Framework (current version)
Registers a delegate that will be called when this CancellationToken is canceled.
Assembly: mscorlib (in mscorlib.dll)
Public Function Register ( callback As Action(Of Object), state As Object ) As CancellationTokenRegistration
Parameters
- callback
-
Type:
System.Action(Of 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.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.
The current ExecutionContext, if one exists, will be captured along with the delegate and will be used when executing it.
Universal Windows Platform
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
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
Show: