File.ReadAllTextAsync Method

Definition

Overloads

ReadAllTextAsync(String, CancellationToken)

Asynchronously opens a text file, reads all the text in the file, and then closes the file.

ReadAllTextAsync(String, Encoding, CancellationToken)

Asynchronously opens a text file, reads all text in the file with the specified encoding, and then closes the file.

ReadAllTextAsync(String, CancellationToken)

Asynchronously opens a text file, reads all the text in the file, and then closes the file.

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)

Parameters

path
String

The file to open for reading.

cancellationToken
CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task<String>

A task that represents the asynchronous read operation, which wraps the string containing all text in the file.

Applies to

ReadAllTextAsync(String, Encoding, CancellationToken)

Asynchronously opens a text file, reads all text in the file with the specified encoding, and then closes the file.

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)

Parameters

path
String

The file to open for reading.

encoding
Encoding

The encoding applied to the contents of the file.

cancellationToken
CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task<String>

A task that represents the asynchronous read operation, which wraps the string containing all text in the file.

Applies to