StreamReader.ReadAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| ReadAsync(Memory<Char>, CancellationToken) |
Lê de forma assíncrona os caracteres do fluxo atual para um bloco de memória. |
| ReadAsync(Char[], Int32, Int32) |
Lê um máximo especificado de caracteres do fluxo atual de forma assíncrona e grava os dados em um buffer, começando no índice especificado. |
ReadAsync(Memory<Char>, CancellationToken)
- Origem:
- StreamReader.cs
- Origem:
- StreamReader.cs
- Origem:
- StreamReader.cs
Lê de forma assíncrona os caracteres do fluxo atual para um bloco de memória.
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
Quando este método é retornado, contém o bloco de memória de caracteres especificado substituídos pelos caracteres lidos da fonte de dados atual.
- cancellationToken
- CancellationToken
O token a se monitorar para solicitações de cancelamento. O valor padrão é None.
Retornos
Uma tarefa de valor que representa a operação de leitura assíncrona. O valor do parâmetro de tipo da tarefa de valor contém o número de caracteres que foram lidos ou 0 caso nenhum dado tenha sido lido no final do fluxo. O número será menor ou igual ao comprimento do buffer, dependendo da disponibilidade dos dados no fluxo.
Exceções
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.
Aplica-se a
ReadAsync(Char[], Int32, Int32)
- Origem:
- StreamReader.cs
- Origem:
- StreamReader.cs
- Origem:
- StreamReader.cs
Lê um máximo especificado de caracteres do fluxo atual de forma assíncrona e grava os dados em um buffer, começando no í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[]
Quando esse método é retornado, contém a matriz de caracteres especificada com os valores entre index e (index + count – 1) substituídos pelos caracteres lidos da origem atual.
- index
- Int32
A posição em buffer na qual a gravação será iniciada.
- count
- Int32
O número máximo de caracteres a serem lidos. Se o final do fluxo for atingido antes que o número especificado de caracteres seja gravado no buffer, o método atual será retornado.
Retornos
Uma tarefa que representa a operação de leitura assíncrona. O valor do parâmetro TResult contém o número total de caracteres lidos no buffer. O valor do resultado poderá ser menor que o número de caracteres solicitados se o número de caracteres disponíveis no momento for menor que o número solicitado ou poderá ser 0 (zero) se o final do fluxo for atingido.
- Atributos
Exceções
buffer é null.
index ou count é negativo.
A soma de index e count é maior que o tamanho do buffer.
O fluxo foi descartado.
O leitor está sendo usado no momento por uma operação de leitura anterior.
Exemplos
O exemplo a seguir mostra como ler todos os caracteres em um arquivo usando o ReadAsync(Char[], Int32, Int32) método . Ele verifica se cada caractere é uma letra, dígito ou espaço em branco antes de adicionar o caractere a uma instância da StringBuilder classe .
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
Comentários
A tarefa é concluída depois que o número de caracteres especificado pelo count parâmetro é lido ou o final do fluxo é atingido.
Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por Read(Char[], Int32, Int32).
