TextReader.ReadAsync Método

  • Referencia

Definición

Espacio de nombres:
System.IO
Ensamblado:
System.Runtime.dll
Ensamblado:
System.Runtime.Extensions.dll
Ensamblado:
netstandard.dll
Ensamblado:
System.IO.dll
Ensamblado:
mscorlib.dll

Sobrecargas

ReadAsync(Memory<Char>, CancellationToken)

Lee de forma asincrónica los caracteres de la secuencia actual en un bloque de memoria.
ReadAsync(Char[], Int32, Int32)

Lee un número máximo de caracteres especificado en el lector de texto actual de forma asincrónica y escribe los datos en un búfer, comenzando en el índice especificado.

ReadAsync(Memory<Char>, CancellationToken)

Source:
TextReader.cs
Source:
TextReader.cs
Source:
TextReader.cs

Lee de forma asincrónica los caracteres de la secuencia actual en un bloque de memoria.

public virtual System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overridable Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parámetros

buffer
Memory<Char>

Cuando este método devuelve un valor, contiene el bloque de memoria especificado de caracteres reemplazados por los caracteres leídos del origen actual.

cancellationToken
CancellationToken

Token para supervisar solicitudes de cancelación. El valor predeterminado es None.

Devoluciones

ValueTask<Int32>

Una tarea de valor que representa la operación de lectura asincrónica. El valor del parámetro de tipo contiene el número de caracteres leídos, o bien 0 si se llega al final de la secuencia y no se ha leído ningún dato. El número será menor o igual que la longitud de buffer, en función de si los datos están disponibles dentro de la secuencia.

Excepciones

OperationCanceledException

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

Se aplica a

ReadAsync(Char[], Int32, Int32)

Source:
TextReader.cs
Source:
TextReader.cs
Source:
TextReader.cs

Lee un número máximo de caracteres especificado en el lector de texto actual de forma asincrónica y escribe los datos en un búfer, comenzando en el índice especificado.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);
public virtual System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overridable Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Parámetros

buffer
Char[]

Cuando este método devuelve un valor, contiene la matriz de caracteres especificada con valores entre index y (index + count - 1) reemplazada por los caracteres leídos del origen actual.

index
Int32

Lugar de buffer en el que comenzará la escritura.

count
Int32

Número máximo de caracteres que se van a leer. Si el final del texto se alcanza antes de leer el número de caracteres especificado en el búfer, el método actual vuelve.

Devoluciones

Task<Int32>

Tarea que representa la operación de lectura asincrónica. El valor del parámetro TResult contiene el número total de bytes leídos en el búfer. El valor del resultado puede ser menor que el número de bytes solicitados si el número de bytes disponibles actualmente es menor que el número solicitado o puede ser 0 (cero) si se ha llegado al final del texto.

Atributos
ComVisibleAttribute

Excepciones

ArgumentNullException

buffer es null.

ArgumentOutOfRangeException

index o count es negativo.

ArgumentException

La suma de index y count es mayor que la longitud del búfer.

ObjectDisposedException

Se ha desechado el lector de texto.

InvalidOperationException

Una operación de lectura anterior está usando actualmente el lector.

Comentarios

La tarea se completa después de que se lea el número de caracteres especificados por el count parámetro o se alcance el final del archivo.

La clase TextReader es una clase abstracta. Por lo tanto, no se crea una instancia en el código. Para obtener un ejemplo de uso del ReadAsync método , consulte el StreamReader.ReadAsync método .

Este método almacena en la tarea que devuelve todas las excepciones que no son de 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, se siguen iniciando de forma sincrónica. Para ver las excepciones almacenadas, consulte las excepciones producidas por Read(Char[], Int32, Int32).

Consulte también

Se aplica a