StreamReader.ReadAsync Método

Definición

Sobrecargas

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 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.Reads a specified maximum number of characters from the current stream 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.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides 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 de la tarea de valor 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 of the value task 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

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

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);
public override System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overrides 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 de la secuencia se alcanza antes de escribir el número de caracteres especificado en el búfer, el método actual vuelve.If the end of the stream is reached before the specified number of characters is written 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 characters read into the buffer. 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.The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream 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 eliminado la secuencia.The stream 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.

Ejemplos

En el ejemplo siguiente se muestra cómo leer todos los caracteres de un archivo mediante el ReadAsync(Char[], Int32, Int32) método.The following example shows how to read all the characters in a file by using the ReadAsync(Char[], Int32, Int32) method. Comprueba si cada carácter es una letra, un dígito o un espacio en blanco antes de agregar el carácter a una instancia de la StringBuilder clase.It checks whether each character is a letter, digit, or white space before adding the character to an instance of the StringBuilder class.

using System;
using System.Windows;
using System.IO;
using System.Text;

namespace WpfApplication
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click_1(object sender, RoutedEventArgs e)
        {
            string filename = @"C:\Example\existingfile.txt";
            char[] result;
            StringBuilder builder = new StringBuilder();

            using (StreamReader reader = File.OpenText(filename))
            {
                result = new char[reader.BaseStream.Length];
                await reader.ReadAsync(result, 0, (int)reader.BaseStream.Length);
            }

            foreach (char c in result)
            {
                if (char.IsLetterOrDigit(c) || char.IsWhiteSpace(c))
                {
                    builder.Append(c);
                }
            }
            FileOutput.Text = builder.ToString();
        }
    }
}
Imports System.Text
Imports System.IO

Class MainWindow

    Private Async Sub Button_Click_1(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "C:\Example\existingfile.txt"
        Dim result() As Char
        Dim builder As StringBuilder = New StringBuilder()

        Using reader As StreamReader = File.OpenText(filename)
            ReDim result(reader.BaseStream.Length)
            Await reader.ReadAsync(result, 0, reader.BaseStream.Length)
        End Using

        For Each c As Char In result
            If (Char.IsLetterOrDigit(c) Or Char.IsWhiteSpace(c)) Then
                builder.Append(c)
            End If
            Next
        FileOutput.Text = builder.ToString()
    End Sub
End Class

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 de la secuencia.The task completes after either the number of characters specified by the count parameter are read or the end of the stream is reached.

Se aplica a