Поделиться через

CancellationToken.Register Метод

  • Ссылка

Определение

Пространство имен:
System.Threading
Сборка:
System.Threading.Tasks.dll
Сборка:
System.Runtime.dll
Сборка:
mscorlib.dll
Сборка:
netstandard.dll

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.

Перегрузки

Register(Action)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.
Register(Action, Boolean)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.
Register(Action<Object,CancellationToken>, Object)

Регистрирует делегат, который будет вызываться при отмене этого cancellationToken .
Register(Action<Object>, Object)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.
Register(Action<Object>, Object, Boolean)

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.

Register(Action)

Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.

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.

Возвращаемое значение

CancellationTokenRegistration

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.

Исключения

ObjectDisposedException

Связанный объект CancellationTokenSource удален.

ArgumentNullException

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

Комментарии

Если этот маркер уже находится в состоянии отмены, делегат будет запущен немедленно и синхронно. Любое исключение, создаваемое делегатом, будет распространено из этого вызова метода.

Текущий ExecutionContext объект фиксируется вместе с делегатом и будет использоваться при его выполнении.

Текущий SynchronizationContext объект не фиксируется.

См. также раздел

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

Register(Action, Boolean)

Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.

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.

useSynchronizationContext
Boolean

Значение, указывающее, следует ли записывать текущий объект SynchronizationContext и использовать его при вызове callback.

Возвращаемое значение

CancellationTokenRegistration

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.

Исключения

ObjectDisposedException

Связанный объект CancellationTokenSource удален.

ArgumentNullException

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

Комментарии

Если этот маркер уже находится в состоянии отмены, делегат будет запущен немедленно и синхронно. Любое исключение, создаваемое делегатом, будет распространено из этого вызова метода.

Текущий ExecutionContext объект фиксируется вместе с делегатом и будет использоваться при его выполнении.

Если useSynchronizationContext имеет значение true, текущий SynchronizationContextобъект , если таковой существует, также фиксируется вместе с делегатом и будет использоваться при его выполнении. SynchronizationContext В противном случае не фиксируется.

См. также раздел

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

Register(Action<Object,CancellationToken>, Object)

Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs

Регистрирует делегат, который будет вызываться при отмене этого cancellationToken .

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

Параметры

callback
Action<Object,CancellationToken>

Делегат, выполняемый при отмене CancellationToken .

state
Object

Состояние, передаваемое обратному вызову callback при вызове делегата. Это может быть значение null.

Возвращаемое значение

CancellationTokenRegistration

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.

Исключения

ArgumentNullException

callback имеет значение null.

Комментарии

Если этот маркер уже находится в состоянии отмены, делегат будет запущен немедленно и синхронно. Любое исключение, создаваемое делегатом, будет распространено из этого вызова метода. Текущий ExecutionContextобъект , если таковой существует, записывается вместе с делегатом и используется при его выполнении. Текущий SynchronizationContext объект не фиксируется.

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

Register(Action<Object>, Object)

Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.

public:
 System::Threading::CancellationTokenRegistration Register(Action<System::Object ^> ^ callback, System::Object ^ state);
public System.Threading.CancellationTokenRegistration Register (Action<object> callback, 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.

state
Object

Состояние, передаваемое обратному вызову callback при вызове делегата. Может содержать пустое значение.

Возвращаемое значение

CancellationTokenRegistration

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.

Исключения

ObjectDisposedException

Связанный объект CancellationTokenSource удален.

ArgumentNullException

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

Комментарии

Если этот маркер уже находится в состоянии отмены, делегат будет запущен немедленно и синхронно. Любое исключение, создаваемое делегатом, будет распространено из этого вызова метода.

Текущий ExecutionContext объект фиксируется вместе с делегатом и будет использоваться при его выполнении.

Текущий SynchronizationContext объект не фиксируется.

См. также раздел

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

Register(Action<Object>, Object, Boolean)

Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs
Исходный код:
CancellationToken.cs

Регистрирует делегат, который будет вызываться при отмене данного токена CancellationToken.

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);
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.

state
Object

Состояние, передаваемое обратному вызову callback при вызове делегата. Может содержать пустое значение.

useSynchronizationContext
Boolean

Логическое значение, указывающее, следует ли записывать текущий объект SynchronizationContext и использовать его при вызове callback.

Возвращаемое значение

CancellationTokenRegistration

Экземпляр CancellationTokenRegistration, который можно использовать для отмены регистрации обратного вызова.

Исключения

ObjectDisposedException

Связанный объект CancellationTokenSource удален.

ArgumentNullException

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

Комментарии

Если этот маркер уже находится в состоянии отмены, делегат будет запущен немедленно и синхронно. Любое исключение, создаваемое делегатом, будет распространено из этого вызова метода.

Текущий ExecutionContext объект фиксируется вместе с делегатом и будет использоваться при его выполнении.

Если useSynchronizationContext имеет значение true, текущий SynchronizationContextобъект , если таковой существует, также фиксируется вместе с делегатом и будет использоваться при его выполнении. SynchronizationContext В противном случае не фиксируется.

См. также раздел

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