File.ReadLinesAsync Metoda

Definice

Obor názvů:

System.IO

Sestavení:

System.Runtime.dll

Přetížení

ReadLinesAsync(String, CancellationToken)	Asynchronně čte řádky souboru.
ReadLinesAsync(String, Encoding, CancellationToken)	Asynchronně čte řádky souboru, který má zadané kódování.

ReadLinesAsync(String, CancellationToken)

Zdroj:

File.cs

Asynchronně čte řádky souboru.

public static System.Collections.Generic.IAsyncEnumerable<string> ReadLinesAsync (string path, System.Threading.CancellationToken cancellationToken = default);

static member ReadLinesAsync : string * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<string>

Public Shared Function ReadLinesAsync (path As String, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of String)

Parametry

path

String

Soubor, který chcete přečíst.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

IAsyncEnumerable<String>

Asynchronní výčet, který představuje všechny řádky souboru, nebo řádky, které jsou výsledkem dotazu.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem ReadLines(String).

ReadLinesAsync(String, Encoding, CancellationToken)

Zdroj:

File.cs

Asynchronně čte řádky souboru, který má zadané kódování.

public static System.Collections.Generic.IAsyncEnumerable<string> ReadLinesAsync (string path, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);

static member ReadLinesAsync : string * System.Text.Encoding * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<string>

Public Shared Function ReadLinesAsync (path As String, encoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of String)

Parametry

path

String

Soubor, který chcete přečíst.

encoding

Encoding

Kódování použité na obsah souboru.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

IAsyncEnumerable<String>

Asynchronní výčet, který představuje všechny řádky souboru, nebo řádky, které jsou výsledkem dotazu.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem ReadLines(String, Encoding).