TplExtensions.ToTask(WaitHandle, Int32, CancellationToken) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
WaitHandleが通知されたときにtrueを返すか、タイムアウトが最初に発生した場合にfalseを返す TPL タスクを作成します。
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。
注釈
返されたタスクの完了は、待機ハンドルを実際に通知するコードに関して非同期です。