This documentation is archived and is not being maintained.
CancellationToken::Register Method (Action<Object>, Object, Boolean)
Visual Studio 2010
Registers a delegate that will be called when this CancellationToken is canceled.
Assembly: mscorlib (in mscorlib.dll)
public: CancellationTokenRegistration Register( Action<Object^>^ callback, Object^ state, bool useSynchronizationContext )
Parameters
- callback
- Type: System::Action<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. |
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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: