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 會與委派一起擷取，並在執行時使用。

如果 為 useSynchronizationContexttrue ，則為目前的 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 會與委派一起擷取，並在執行時使用。

如果 為 useSynchronizationContexttrue ，則為目前的 SynchronizationContext ，如果存在，也會與委派一起擷取，並在執行時使用。 否則， SynchronizationContext 不會擷取 。

另請參閱

• 取消
• 工作取消
• 作法：註冊取消要求的回呼