TplExtensions.ToTask(WaitHandle, Int32, CancellationToken) Metoda

Definice

Obor názvů:

Microsoft.VisualStudio.Threading

Sestavení:

Microsoft.VisualStudio.Threading.dll

Balíček:

Microsoft.VisualStudio.Threading v17.12.19

Vytvoří úlohu TPL, která se vrátí true při signálu WaitHandle nebo vrátí false , pokud dojde k vypršení časového limitu jako první.

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)

Parametry

handle

WaitHandle

Popisovač, jehož signál aktivuje dokončení úkolu. Nepoužívejte sem.Mutex

timeout

Int32

Časový limit (v milisekundách), po jehož uplynutí se úkol vrátí false , pokud popisovač není do této doby signalizovat.

cancellationToken

CancellationToken

Token, jehož zrušení způsobí okamžité dokončení vrácené úlohy ve zrušeném stavu.

Návraty

Task<Boolean>

Úkol, který se dokončí, když je signál popisovače nebo vypršení časového limitu nebo když je zrušen token zrušení volajícího. Pokud se úkol dokončí, protože je signalizoval popisovač, výsledek úkolu je true. Pokud se úkol dokončí, protože popisovač není signalizoval před vypršením časového limitu, výsledek úkolu je false.

Poznámky

Dokončení vrácené úlohy je asynchronní vzhledem ke kódu, který ve skutečnosti signalizuje popisovač čekání.