StringReader.ReadAsync Método

Definição

Espaço de Nomes:
System.IO
Assemblagem:
netstandard.dll
Assemblagens:
mscorlib.dll, System.IO.dll
Assemblagem:
mscorlib.dll
Assemblagem:
System.IO.dll

Sobrecargas

Name Description
ReadAsync(Memory<Char>, CancellationToken)

Lê assíncronamente todos os caracteres da cadeia de entrada, começando na posição atual, e avança a posição atual até ao fim da cadeia de entrada.
ReadAsync(Char[], Int32, Int32)

Lê um número máximo especificado de caracteres da cadeia atual de forma assíncrona e escreve os dados num buffer, começando no índice especificado.

ReadAsync(Memory<Char>, CancellationToken)

Lê assíncronamente todos os caracteres da cadeia de entrada, começando na posição atual, e avança a posição atual até ao fim da cadeia de entrada.

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>

Quando este método regressa, contém os caracteres lidos da fonte atual.

cancellationToken
CancellationToken

O token para monitorizar pedidos de cancelamento. O valor predefinido é None.

Devoluções

ValueTask<Int32>

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.

Exceções

OperationCanceledException

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 da cadeia 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 da cadeia for alcançado antes do número especificado de caracteres ser escrito no buffer, o método retorna.

Devoluções

Task<Int32>

Uma tarefa que representa a operação de leitura assíncrona. O valor do TResult parâmetro contém o número total de bytes lidos no buffer. O valor do resultado pode ser inferior ao número de bytes solicitados se o número de bytes atualmente disponíveis for inferior ao número pedido, ou pode ser 0 (zero) se o fim da cadeia for atingido.

Atributos
ComVisibleAttribute

Exceções

ArgumentNullException

buffer é null.

ArgumentOutOfRangeException

index ou count é negativo.

ArgumentException

A soma de index e count é maior do que o comprimento do buffer.

ObjectDisposedException

O leitor de cordas foi descartado.

InvalidOperationException

O leitor está atualmente em uso por uma operação de leitura anterior.

Exemplos

O exemplo seguinte mostra como ler os primeiros 23 caracteres de uma cadeia de forma assíncrona.

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            string stringToRead = "Some characters to read but not all";
            char[] charsRead = new char[stringToRead.Length];

            using (StringReader reader = new StringReader(stringToRead))
            {
                await reader.ReadAsync(charsRead, 0, 23);
                Console.WriteLine(charsRead);
            }
        }
    }
}
// The example displays the following output:
// Some characters to read
//

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = "Some characters to read but not all"
        Dim charsRead(stringToRead.Length) As Char

        Using reader As StringReader = New StringReader(stringToRead)
            Await reader.ReadAsync(charsRead, 0, 23)
            Console.WriteLine(charsRead)
        End Using
    End Sub

End Module
' The example displays the following output:
' Some characters to read
'

Observações

A tarefa é concluída após a leitura do número de caracteres especificados pelo count parâmetro ou após o fim da cadeia ser atingida.

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

Aplica-se a