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、現在SynchronizationContextの が存在する場合は、デリゲートと共にキャプチャされ、実行時に使用trueされます。 それ以外の場合、 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 に渡される状態。 null でもかまいません。

戻り値

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 に渡される状態。 null でもかまいません。

useSynchronizationContext
Boolean

現在の SynchronizationContext をキャプチャし、callback を呼び出すときに使用するかどうかを示すブール値。

戻り値

CancellationTokenRegistration

コールバックの登録解除に使用できる CancellationTokenRegistration インスタンス。

例外

ObjectDisposedException

関連付けられている CancellationTokenSource は破棄されています。

ArgumentNullException

callback が null です。

注釈

このトークンが既に取り消された状態の場合、デリゲートは直ちに同期的に実行されます。 デリゲートによって生成される例外はすべて、このメソッド呼び出しから伝達されます。

現在 ExecutionContext の はデリゲートと共にキャプチャされ、実行時に使用されます。

が の場合useSynchronizationContext、現在SynchronizationContextの が存在する場合は、デリゲートと共にキャプチャされ、実行時に使用trueされます。 それ以外の場合、 SynchronizationContext はキャプチャされません。

こちらもご覧ください

適用対象