TextReader.ReadAsync Método

Definición

Sobrecargas

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.Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.

ReadAsync(Memory<Char>, CancellationToken)

Lee de forma asincrónica los caracteres de la secuencia actual en un bloque de memoria.Asynchronously reads the characters from the current stream into a memory block.

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.Reads a specified maximum number of characters from the current text reader asynchronously and writes the data to a buffer, beginning at the specified index.

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.When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.

index
Int32

Lugar de buffer en el que comenzará la escritura.The position in buffer at which to begin writing.

count
Int32

Número máximo de caracteres que se van a leer.The maximum number of characters to read. 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.If the end of the text is reached before the specified number of characters is read into the buffer, the current method returns.

Devoluciones

Task<Int32>

Tarea que representa la operación de lectura asincrónica.A task that represents the asynchronous read operation. El valor del parámetro TResult contiene el número total de bytes leídos en el búfer.The value of the TResult parameter contains the total number of bytes read into the buffer. 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.The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the text has been reached.

Atributos

Excepciones

buffer es null.buffer is null.

index o count es negativo.index or count is negative.

La suma de index y count es mayor que la longitud del búfer.The sum of index and count is larger than the buffer length.

Se ha desechado el lector de texto.The text reader has been disposed.

Una operación de lectura anterior está usando actualmente el lector.The reader is currently in use by a previous read operation.

Comentarios

La tarea se completa después de que se lea el número de caracteres especificado por el count parámetro o se alcance el final del archivo.The task completes after either the number of characters specified by the count parameter are read or the end of the file is reached.

La clase TextReader es una clase abstracta.The TextReader class is an abstract class. Por lo tanto, no se crea una instancia de ella en el código.Therefore, you do not instantiate it in your code. Para obtener un ejemplo de cómo usar el ReadAsync método, vea el StreamReader.ReadAsync método.For an example of using the ReadAsync method, see the StreamReader.ReadAsync method.

Consulte también

Se aplica a

ReadAsync(Memory<Char>, CancellationToken)

Lee de forma asincrónica los caracteres de la secuencia actual en un bloque de memoria.Asynchronously reads the characters from the current stream into a memory block.

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.When this method returns, contains the specified memory block of characters replaced by the characters read from the current source.

cancellationToken
CancellationToken

Token para supervisar solicitudes de cancelación.The token to monitor for cancellation requests. El valor predeterminado es None.The default value is None.

Devoluciones

ValueTask<Int32>

Una tarea de valor que representa la operación de lectura asincrónica.A value task that represents the asynchronous read operation. 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.The value of the type parameter contains the number of characters that have been read, or 0 if at the end of the stream and no data was read. 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.The number will be less than or equal to the buffer length, depending on whether the data is available within the stream.

Se aplica a