TplExtensions.ToTask(WaitHandle, Int32, CancellationToken) 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
建立 TPL 工作,以在 收到訊號時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
令牌,其取消會導致傳回的工作立即在已取消狀態中完成。
傳回
當句柄發出訊號或逾時,或呼叫端取消令牌時完成的工作。
如果工作因為句柄發出訊號而完成,則工作的結果為 true
。
如果工作因為逾時之前未發出句柄的訊號而完成,則工作的結果為 false
。
備註
傳回工作的完成與實際發出等候句柄訊號的程式代碼有關,是異步的。