StreamReader.ReadAsync Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Sobrecargas
| Name | Description |
|---|---|
| ReadAsync(Memory<Char>, CancellationToken) |
Lê assíncronamente os caracteres do fluxo atual para um bloco de memória. |
| ReadAsync(Char[], Int32, Int32) |
Lê um número máximo especificado de caracteres do fluxo atual de forma assíncrona e escreve os dados num buffer, começando no índice especificado. |
ReadAsync(Memory<Char>, CancellationToken)
Lê assíncronamente 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 regressa, contém o bloco de memória especificado de caracteres substituído pelos caracteres lidos da fonte atual.
- cancellationToken
- CancellationToken
O token para monitorizar pedidos de cancelamento. O valor predefinido é None.
Devoluções
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 se no final do fluxo não houver dados lidos. O número será inferior ou igual ao buffer comprimento, dependendo se os dados estão disponíveis dentro do fluxo.
Exceções
O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.
Aplica-se a
ReadAsync(Char[], Int32, Int32)
Lê um número máximo especificado de caracteres do fluxo atual de forma assíncrona e escreve os dados num 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 este método regressa, contém o array de caracteres especificado com os valores entre index e (index + count - 1) substituídos pelos caracteres lidos da fonte atual.
- index
- Int32
A posição buffer em que começar a escrever.
- count
- Int32
O número máximo de caracteres para ler. Se o fim do fluxo for alcançado antes de o número especificado de caracteres ser escrito no buffer, o método atual retorna.
Devoluções
Uma tarefa que representa a operação de leitura assíncrona. O valor do TResult parâmetro contém o número total de caracteres lidos no buffer. O valor do resultado pode ser inferior ao número de caracteres solicitados se o número de caracteres atualmente disponíveis for inferior ao número pedido, ou pode ser 0 (zero) se o fim do fluxo for alcançado.
- Atributos
Exceções
buffer é null.
index ou count é negativo.
A soma de index e count é maior do que o comprimento do buffer.
O riacho foi eliminado.
O leitor está atualmente em uso por uma operação de leitura anterior.
Exemplos
O exemplo seguinte mostra como ler todos os caracteres de um ficheiro usando o ReadAsync(Char[], Int32, Int32) método. Verifica se cada carácter é uma letra, dígito ou espaço em branco antes de adicionar o carácter 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
Observações
A tarefa é concluída após a leitura do número de caracteres especificados count pelo parâmetro ou após o fim do fluxo ser atingido.
Este método armazena na tarefa que devolve todas as exceções de não-utilização que o equivalente síncrono do método pode lançar. Se uma exceção for armazenada na tarefa devolvida, essa exceção será lançada quando a tarefa for aguardada. As exceções de uso, como ArgumentException, ainda são lançadas de forma síncrona. Para as exceções armazenadas, veja as exceções lançadas por Read(Char[], Int32, Int32).