StreamReader.ReadBlockAsync Método

Definición

Espacio de nombres:

System.IO

Ensamblado:

System.Runtime.dll

Sobrecargas

ReadBlockAsync(Memory<Char>, CancellationToken)	Lee de forma asincrónica los caracteres de la secuencia actual y escribe los datos en un búfer.
ReadBlockAsync(Char[], Int32, Int32)	Lee de forma asincrónica un número máximo de caracteres especificado en la secuencia actual y escribe los datos en un búfer, comenzando en el índice especificado.

ReadBlockAsync(Memory<Char>, CancellationToken)

Source:

StreamReader.cs

Lee de forma asincrónica los caracteres de la secuencia actual y escribe los datos en un búfer.

public override System.Threading.Tasks.ValueTask<int> ReadBlockAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadBlockAsync (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 de la tarea de valor contiene el número total de caracteres leídos en el búfer. El valor del resultado puede ser menor que el número de caracteres solicitados si el número de caracteres disponibles actualmente es menor que el número solicitado o puede ser 0 (cero) si se ha llegado al final de la secuencia.

Excepciones

OperationCanceledException

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

ReadBlockAsync(Char[], Int32, Int32)

Source:

StreamReader.cs

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

public:
 override System::Threading::Tasks::Task<int> ^ ReadBlockAsync(cli::array <char> ^ buffer, int index, int count);

public override System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);

override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadBlockAsync (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 de la secuencia se alcanza antes de escribir el número de caracteres especificado en el búfer, el método 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 caracteres solicitados si el número de caracteres disponibles actualmente es menor que el número solicitado o puede ser 0 (cero) si se ha llegado al final de la secuencia.

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 eliminado la secuencia.

InvalidOperationException

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

Comentarios

La tarea no se completa hasta que se lee el número de caracteres especificados por el count parámetro o se alcanza el final de la secuencia.

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 ReadBlock(Char[], Int32, Int32).