CancellationToken.Register Метод

Определение

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

Перегрузки

Register(Action)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

Register(Action, Boolean)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

Register(Action<Object>, Object)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

Register(Action<Object>, Object, Boolean)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

Register(Action)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

public:
 System::Threading::CancellationTokenRegistration Register(Action ^ callback);
public System.Threading.CancellationTokenRegistration Register (Action callback);
member this.Register : Action -> System.Threading.CancellationTokenRegistration
Public Function Register (callback As Action) As CancellationTokenRegistration

Параметры

callback
Action

Делегат, выполняемый при отмене токена CancellationToken.The delegate to be executed when the CancellationToken is canceled.

Возвраты

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.The CancellationTokenRegistration instance that can be used to unregister the callback.

Исключения

Связанный объект CancellationTokenSource удален.The associated CancellationTokenSource has been disposed.

Параметр callback имеет значение null.callback is null.

Комментарии

Если этот токен уже находится в состоянии Canceled, делегат будет выполняться немедленно и синхронно.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.

Текущий ExecutionContext захватывается вместе с делегатом и будет использоваться при его выполнении.The current ExecutionContext is captured along with the delegate and will be used when executing it.

Текущий SynchronizationContext не захвачен.The current SynchronizationContext is not captured.

Дополнительно

Register(Action, Boolean)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

public:
 System::Threading::CancellationTokenRegistration Register(Action ^ callback, bool useSynchronizationContext);
public System.Threading.CancellationTokenRegistration Register (Action callback, bool useSynchronizationContext);
member this.Register : Action * bool -> System.Threading.CancellationTokenRegistration
Public Function Register (callback As Action, useSynchronizationContext As Boolean) As CancellationTokenRegistration

Параметры

callback
Action

Делегат, выполняемый при отмене токена CancellationToken.The delegate to be executed when the CancellationToken is canceled.

useSynchronizationContext
Boolean

Значение, указывающее, следует ли записывать текущий объект SynchronizationContext и использовать его при вызове callback.A value that indicates whether to capture the current SynchronizationContext and use it when invoking the callback.

Возвраты

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.The CancellationTokenRegistration instance that can be used to unregister the callback.

Исключения

Связанный объект CancellationTokenSource удален.The associated CancellationTokenSource has been disposed.

Параметр callback имеет значение null.callback is null.

Комментарии

Если этот токен уже находится в состоянии Canceled, делегат будет выполняться немедленно и синхронно.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.

Текущий ExecutionContext захватывается вместе с делегатом и будет использоваться при его выполнении.The current ExecutionContext is captured along with the delegate and will be used when executing it.

Если useSynchronizationContext равно true, то текущий SynchronizationContext, если таковой существует, также захватывается вместе с делегатом и будет использоваться при его выполнении.If useSynchronizationContext is true, the current SynchronizationContext, if one exists, is also captured along with the delegate and will be used when executing it. В противном случае SynchronizationContext не фиксируется.Otherwise, SynchronizationContext is not captured.

Дополнительно

Register(Action<Object>, Object)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

public:
 System::Threading::CancellationTokenRegistration Register(Action<System::Object ^> ^ callback, System::Object ^ state);
public System.Threading.CancellationTokenRegistration Register (Action<object> callback, object state);
member this.Register : Action<obj> * obj -> System.Threading.CancellationTokenRegistration
Public Function Register (callback As Action(Of Object), state As Object) As CancellationTokenRegistration

Параметры

callback
Action<Object>

Делегат, выполняемый при отмене токена CancellationToken.The delegate to be executed when the CancellationToken is canceled.

state
Object

Состояние, передаваемое обратному вызову callback при вызове делегата.The state to pass to the callback when the delegate is invoked. Может содержать пустое значение.This may be null.

Возвраты

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.The CancellationTokenRegistration instance that can be used to unregister the callback.

Исключения

Связанный объект CancellationTokenSource удален.The associated CancellationTokenSource has been disposed.

Параметр callback имеет значение null.callback is null.

Комментарии

Если этот токен уже находится в состоянии Canceled, делегат будет выполняться немедленно и синхронно.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.

Текущий ExecutionContext захватывается вместе с делегатом и будет использоваться при его выполнении.The current ExecutionContext is captured along with the delegate and will be used when executing it.

Текущий SynchronizationContext не захвачен.The current SynchronizationContext is not captured.

Дополнительно

Register(Action<Object>, Object, Boolean)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.Registers a delegate that will be called when this CancellationToken is canceled.

public:
 System::Threading::CancellationTokenRegistration Register(Action<System::Object ^> ^ callback, System::Object ^ state, bool useSynchronizationContext);
public System.Threading.CancellationTokenRegistration Register (Action<object> callback, object state, bool useSynchronizationContext);
member this.Register : Action<obj> * obj * bool -> System.Threading.CancellationTokenRegistration
Public Function Register (callback As Action(Of Object), state As Object, useSynchronizationContext As Boolean) As CancellationTokenRegistration

Параметры

callback
Action<Object>

Делегат, выполняемый при отмене токена CancellationToken.The delegate to be executed when the CancellationToken is canceled.

state
Object

Состояние, передаваемое обратному вызову callback при вызове делегата.The state to pass to the callback when the delegate is invoked. Может содержать пустое значение.This may be null.

useSynchronizationContext
Boolean

Логическое значение, указывающее, следует ли записывать текущий объект SynchronizationContext и использовать его при вызове callback.A Boolean value that indicates whether to capture the current SynchronizationContext and use it when invoking the callback.

Возвраты

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.The CancellationTokenRegistration instance that can be used to unregister the callback.

Исключения

Связанный объект CancellationTokenSource удален.The associated CancellationTokenSource has been disposed.

Параметр callback имеет значение null.callback is null.

Комментарии

Если этот токен уже находится в состоянии Canceled, делегат будет выполняться немедленно и синхронно.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.

Текущий ExecutionContext захватывается вместе с делегатом и будет использоваться при его выполнении.The current ExecutionContext is captured along with the delegate and will be used when executing it.

Если useSynchronizationContext равно true, то текущий SynchronizationContext, если таковой существует, также захватывается вместе с делегатом и будет использоваться при его выполнении.If useSynchronizationContext is true, the current SynchronizationContext, if one exists, is also captured along with the delegate and will be used when executing it. В противном случае SynchronizationContext не фиксируется.Otherwise, SynchronizationContext is not captured.

Дополнительно

Применяется к