CancellationToken.UnsafeRegister Method

Definition

Namespace:

System.Threading

Assembly:

System.Runtime.dll

Overloads

UnsafeRegister(Action<Object,CancellationToken>, Object)	Registers a delegate that will be called when this CancellationToken is canceled.
UnsafeRegister(Action<Object>, Object)	Registers a delegate that is called when this CancellationToken is canceled.

UnsafeRegister(Action<Object,CancellationToken>, Object)

Source:

CancellationToken.cs

Registers a delegate that will be called when this CancellationToken is canceled.

public:
 System::Threading::CancellationTokenRegistration UnsafeRegister(Action<System::Object ^, System::Threading::CancellationToken> ^ callback, System::Object ^ state);

public System.Threading.CancellationTokenRegistration UnsafeRegister (Action<object?,System.Threading.CancellationToken> callback, object? state);

member this.UnsafeRegister : Action<obj, System.Threading.CancellationToken> * obj -> System.Threading.CancellationTokenRegistration

Public Function UnsafeRegister (callback As Action(Of Object, CancellationToken), state As Object) As CancellationTokenRegistration

Parameters

callback

Action<Object,CancellationToken>

The delegate to be executed when the CancellationToken is canceled.

state

Object

The state to pass to the callback when the delegate is invoked. This may be null.

Returns

CancellationTokenRegistration

The CancellationTokenRegistration instance that can be used to unregister the callback.

Exceptions

ArgumentNullException

callback is null.

Remarks

If this token is already in the canceled state, the delegate will be run immediately and synchronously. Any exception the delegate generates is propagated out of this method call. ExecutionContext is not captured or flowed to the callback's invocation.

UnsafeRegister(Action<Object>, Object)

Source:

CancellationToken.cs

Registers a delegate that is called when this CancellationToken is canceled.

public:
 System::Threading::CancellationTokenRegistration UnsafeRegister(Action<System::Object ^> ^ callback, System::Object ^ state);

public System.Threading.CancellationTokenRegistration UnsafeRegister (Action<object?> callback, object? state);

member this.UnsafeRegister : Action<obj> * obj -> System.Threading.CancellationTokenRegistration

Public Function UnsafeRegister (callback As Action(Of Object), state As Object) As CancellationTokenRegistration

Parameters

callback

Action<Object>

The delegate to execute when the CancellationToken is canceled.

state

Object

The state to pass to the callback when the delegate is invoked. This may be null.

Returns

CancellationTokenRegistration

An object that can be used to unregister the callback.

Exceptions

ArgumentNullException

callback is null.

Remarks

If this token is already in the canceled state, the delegate is run immediately and synchronously. Any exception the delegate generates is propagated out of this method call.

The ExecutionContext is not captured or flowed to the callback's invocation.