|
|
| .NET Framework Class Library |
| CancellationToken..::.Register Method (Action<(Of <(Object>)>), Object, Boolean) |
| CancellationToken Structure See Also Send Feedback |
Registers a delegate that will be called when this
CancellationToken is canceled.
Namespace:
System.Threading
Assembly:
System.Threading (in System.Threading.dll)
Syntax
| Visual Basic (Declaration) |
|---|
Public Function Register ( _ callback As Action(Of Object), _ state As Object, _ useSynchronizationContext As Boolean _ ) As CancellationTokenRegistration |
| C# |
|---|
public CancellationTokenRegistration Register( Action<Object> callback, Object state, bool useSynchronizationContext ) |
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
The CancellationTokenRegistration instance that can be used to deregister the callback.Remarks
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.
Exceptions
| Exception | Condition |
|---|---|
| System..::.ArgumentNullException | callback is null. |
| System..::.ObjectDisposedException | The associated CancellationTokenSource has been disposed. |
See Also
