File.ReadAllTextAsync Método

Definición

Espacio de nombres:

System.IO

Ensamblado:

System.Runtime.dll

Sobrecargas

ReadAllTextAsync(String, CancellationToken)	Abre de forma asincrónica un archivo de texto, lee todo el texto del archivo y, a continuación, cierra el archivo.
ReadAllTextAsync(String, Encoding, CancellationToken)	Abre de forma asincrónica un archivo de texto, lee todo el texto del archivo con la codificación especificada y, a continuación, cierra el archivo.

ReadAllTextAsync(String, CancellationToken)

Source:

File.cs

Abre de forma asincrónica un archivo de texto, lee todo el texto del archivo y, a continuación, cierra el archivo.

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)

Parámetros

path

String

Archivo que se va a abrir para su lectura.

cancellationToken

CancellationToken

Token que se va a supervisar para las solicitudes de cancelación. El valor predeterminado es None.

Devoluciones

Task<String>

Tarea que representa la operación de lectura asincrónica, que encapsula la cadena que contiene todo el texto del archivo.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Este método almacena en la tarea que devuelve todas las excepciones de no uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, todavía se producen sincrónicamente. Para las excepciones almacenadas, consulte las excepciones producidas por ReadAllText(String).

ReadAllTextAsync(String, Encoding, CancellationToken)

Source:

File.cs

Abre de forma asincrónica un archivo de texto, lee todo el texto del archivo con la codificación especificada y, a continuación, cierra el archivo.

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)

Parámetros

path

String

Archivo que se va a abrir para su lectura.

encoding

Encoding

Codificación aplicada al contenido del archivo.

cancellationToken

CancellationToken

Token que se va a supervisar para las solicitudes de cancelación. El valor predeterminado es None.

Devoluciones

Task<String>

Tarea que representa la operación de lectura asincrónica, que encapsula la cadena que contiene todo el texto del archivo.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Este método almacena en la tarea que devuelve todas las excepciones de no uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, todavía se producen sincrónicamente. Para las excepciones almacenadas, consulte las excepciones producidas por ReadAllText(String, Encoding).