CancellationToken.Register Method (Action)
Registers a delegate that will be called when this CancellationToken is canceled.
Namespace: System.Threading
Assembly: mscorlib (in mscorlib.dll)
Parameters
- callback
- Type: System.Action
The delegate to be executed when the CancellationToken is canceled.
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 propagated 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.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.