CancellationToken.Register 方法

定义

命名空间:

System.Threading

程序集:

System.Runtime.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)

Source:

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)

Source:

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)

Source:

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)

Source:

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

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 的状态。 这可能为 null。

返回

CancellationTokenRegistration

可用于注销回调的 CancellationTokenRegistration 实例。

例外

ObjectDisposedException

关联 CancellationTokenSource 已被释放。

ArgumentNullException

callback 为 null。

注解

如果此令牌已处于取消状态，则会立即同步运行委托。 委托生成的任何异常都将从此方法调用中传播出来。

当前 ExecutionContext 与委托一起捕获，在执行它时将使用它。

不会捕获当前 SynchronizationContext 。

另请参阅

• 取消
• 任务取消
• 如何：注册取消请求的回叫

Register(Action<Object>, Object, Boolean)

Source:

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

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 的状态。 这可能为 null。

useSynchronizationContext

Boolean

一个布尔值，该值指示是否捕获当前 SynchronizationContext 并在调用 callback 时使用它。

返回

CancellationTokenRegistration

可用于注销回调的 CancellationTokenRegistration 实例。

例外

ObjectDisposedException

关联 CancellationTokenSource 已被释放。

ArgumentNullException

callback 为 null。

注解

如果此令牌已处于取消状态，则会立即同步运行委托。 委托生成的任何异常都将从此方法调用中传播出来。

当前 ExecutionContext 与委托一起捕获，在执行它时将使用它。

如果 useSynchronizationContext 为 true，则当前 SynchronizationContext（如果存在）也随委托一起捕获，在执行委托时将使用它。 否则， SynchronizationContext 不会捕获 。

另请参阅

• 取消
• 任务取消
• 如何：注册取消请求的回叫