File.ReadAllTextAsync Metoda

Definicja

Przestrzeń nazw:

System.IO

Zestaw:

System.Runtime.dll

Przeciążenia

ReadAllTextAsync(String, CancellationToken)	Asynchronicznie otwiera plik tekstowy, odczytuje cały tekst w pliku, a następnie zamyka plik.
ReadAllTextAsync(String, Encoding, CancellationToken)	Asynchronicznie otwiera plik tekstowy, odczytuje cały tekst w pliku z określonym kodowaniem, a następnie zamyka plik.

ReadAllTextAsync(String, CancellationToken)

Źródło:

File.cs

Asynchronicznie otwiera plik tekstowy, odczytuje cały tekst w pliku, a następnie zamyka plik.

public static System.Threading.Tasks.Task<string> ReadAllTextAsync (string path, System.Threading.CancellationToken cancellationToken = default);

static member ReadAllTextAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Shared Function ReadAllTextAsync (path As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)

Parametry

path

String

Plik do otwarcia do odczytu.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Wartość domyślna to None.

Zwraca

Task<String>

Zadanie reprezentujące operację odczytu asynchronicznego, która opakowuje ciąg zawierający cały tekst w pliku.

Wyjątki

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Ta metoda przechowuje w zadaniu zwraca wszystkie wyjątki inne niż użycie, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwróconym zadaniu, ten wyjątek zostanie zgłoszony, gdy zadanie będzie oczekiwać. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłaszane przez ReadAllText(String).

ReadAllTextAsync(String, Encoding, CancellationToken)

Źródło:

File.cs

Asynchronicznie otwiera plik tekstowy, odczytuje cały tekst w pliku z określonym kodowaniem, a następnie zamyka plik.

public static System.Threading.Tasks.Task<string> ReadAllTextAsync (string path, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);

static member ReadAllTextAsync : string * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

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

Parametry

path

String

Plik do otwarcia do odczytu.

encoding

Encoding

Kodowanie zastosowane do zawartości pliku.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Wartość domyślna to None.

Zwraca

Task<String>

Zadanie reprezentujące operację odczytu asynchronicznego, która opakowuje ciąg zawierający cały tekst w pliku.

Wyjątki

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Ta metoda przechowuje w zadaniu zwraca wszystkie wyjątki inne niż użycie, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwróconym zadaniu, ten wyjątek zostanie zgłoszony, gdy zadanie będzie oczekiwać. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłaszane przez ReadAllText(String, Encoding).