TplExtensions.ToTask(WaitHandle, Int32, CancellationToken) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
が通知されたときに を返true
すか、タイムアウトが最初に発生した場合に をfalse
返す TPL タスクを作成WaitHandleします。
public static System.Threading.Tasks.Task<bool> ToTask (this System.Threading.WaitHandle handle, int timeout = -1, System.Threading.CancellationToken cancellationToken = default);
static member ToTask : System.Threading.WaitHandle * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
<Extension()>
Public Function ToTask (handle As WaitHandle, Optional timeout As Integer = -1, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)
パラメーター
- handle
- WaitHandle
タスクの完了をトリガーするシグナルを持つハンドル。 ここでは を Mutex 使用しないでください。
- timeout
- Int32
その時点でハンドルが通知されない場合にタスクが返 false
すタイムアウト (ミリ秒単位)。
- cancellationToken
- CancellationToken
取り消された状態で、返されたタスクが直ちに完了するキャンセルを行うトークン。
戻り値
ハンドルが通知またはタイムアウトしたとき、または呼び出し元のキャンセル トークンが取り消されたときに完了するタスク。
ハンドルが通知されるためにタスクが完了した場合、タスクの結果は になります true
。
タイムアウト前にハンドルが通知されないためにタスクが完了した場合、タスクの結果は になります false
。
注釈
返されるタスクの完了は、実際に待機ハンドルを通知するコードに関して非同期です。