StreamReader.ReadAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| Nombre | Description |
|---|---|
| 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 especificado de caracteres de la secuencia actual de forma asincrónica y escribe los datos en un búfer, empezando por el índice especificado. |
ReadAsync(Memory<Char>, CancellationToken)
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
Cuando este método devuelve, contiene el bloque de memoria especificado de caracteres reemplazados por los caracteres leídos del origen actual.
- cancellationToken
- CancellationToken
Token que se va a supervisar para las solicitudes de cancelación. El valor por defecto es None.
Devoluciones
Tarea de valor que representa la operación de lectura asincrónica. El valor del parámetro type de la tarea value contiene el número de caracteres leídos o 0 si al final de la secuencia y no se leyó ningún dato. El número será menor o igual que la buffer longitud, en función de si los datos están disponibles dentro de la secuencia.
Excepciones
Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.
Se aplica a
ReadAsync(Char[], Int32, Int32)
Lee un número máximo especificado de caracteres de la secuencia actual de forma asincrónica y escribe los datos en un búfer, empezando por 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);[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, contiene la matriz de caracteres especificada con los valores entre index y (index + count - 1) reemplazados por los caracteres leídos del origen actual.
- index
- Int32
Posición en la buffer que se va a empezar a escribir.
- count
- Int32
Número máximo de caracteres que se van a leer. Si se alcanza el final de la secuencia antes de escribir el número especificado de caracteres en el búfer, el método actual devuelve.
Devoluciones
Tarea que representa la operación de lectura asincrónica. El valor del TResult parámetro contiene el número total de caracteres leídos en el búfer. El valor de resultado puede ser menor que el número de caracteres solicitado si el número de caracteres disponibles actualmente es menor que el número solicitado, o puede ser 0 (cero) si se ha alcanzado el final de la secuencia.
- Atributos
Excepciones
buffer es null.
index o count es negativo.
La suma de index y count es mayor que la longitud del búfer.
Se ha eliminado la secuencia.
El lector está actualmente en uso mediante una operación de lectura anterior.
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 que se lea el número de caracteres especificados por el count parámetro o se alcance el final de la secuencia.
Este método almacena en la tarea que devuelve todas las excepciones de no 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, todavía se producen sincrónicamente. Para las excepciones almacenadas, consulte las excepciones producidas por Read(Char[], Int32, Int32).