StreamReader.ReadAsync Método

Definición

Espacio de nombres:

System.IO

Ensamblado:

System.Runtime.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 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.

ReadAsync(Memory<Char>, CancellationToken)

Source:

StreamReader.cs

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

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.

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 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.

ReadAsync(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> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);

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>

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.

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 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 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.

Ejemplos

En el ejemplo siguiente se muestra cómo leer todos los caracteres de un archivo mediante el ReadAsync(Char[], Int32, Int32) método . 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 .

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 leer el número de caracteres especificados por el count parámetro o del 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, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por Read(Char[], Int32, Int32).