CancellationToken.Register Method (Action(Of Object), Object, 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.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Function Register ( _ callback As Action(Of Object), _ state As Object, _ useSynchronizationContext As Boolean _ ) 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.
- 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.CancellationTokenRegistrationThe CancellationTokenRegistration instance that can be used to deregister the callback.
| Exception | Condition |
|---|---|
| ObjectDisposedException | The associated CancellationTokenSource has been disposed. |
| ArgumentNullException | callback is null. |
Show: