TplExtensions.ToTask(WaitHandle, Int32, CancellationToken) 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
建立一個 TPL 任務,當 a WaitHandle 被發出訊號時回傳true,或在先發生超時時返回false。
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
一個標記,其取消會使返回的任務立即以取消狀態完成。
傳回
當句柄被發出訊號或逾時,或呼叫者的取消令牌被取消時,任務即完成。
若任務因 handle 被訊號而完成,則任務結果為 true。
若任務完成是因為在逾時前未對 handle 發出訊號,則任務結果為 false。
備註
回傳任務的完成與實際指示等待句柄的程式碼是非同步的。