StreamReader.ReadToEndAsync Método

Definição

Namespace:
System.IO
Assemblies:
mscorlib.dll, System.IO.dll
Assembly:
mscorlib.dll
Assembly:
System.IO.dll
Assembly:
netstandard.dll

Lê todos os caracteres da posição atual até o final do fluxo de forma assíncrona e os retorna como uma cadeia de caracteres.

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync();
public override System.Threading.Tasks.Task<string> ReadToEndAsync();
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<string> ReadToEndAsync();
override this.ReadToEndAsync : unit -> System.Threading.Tasks.Task<string>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadToEndAsync : unit -> System.Threading.Tasks.Task<string>
Public Overrides Function ReadToEndAsync () As Task(Of String)

Retornos

Task<String>

Uma tarefa que representa a operação de leitura assíncrona. O valor do TResult parâmetro contém uma cadeia de caracteres com os caracteres da posição atual até o final do fluxo.

Atributos
ComVisibleAttribute

Exceções

ArgumentOutOfRangeException

O número de caracteres é maior que Int32.MaxValue.

ObjectDisposedException

O fluxo foi descartado.

InvalidOperationException

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

Exemplos

O exemplo a seguir mostra como ler o conteúdo de um arquivo usando o ReadToEndAsync() método.

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static async Task Main()
        {
            await ReadCharacters();
        }

        static async Task ReadCharacters()
        {
            String result;
            using (StreamReader reader = File.OpenText("existingfile.txt"))
            {
                Console.WriteLine("Opened file.");
                result = await reader.ReadToEndAsync();
                Console.WriteLine("Contains: " + result);
            }
        }
    }
}

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim result As String

        Using reader As StreamReader = File.OpenText("existingfile.txt")
            Console.WriteLine("Opened file.")
            result = Await reader.ReadToEndAsync()
            Console.WriteLine("Contains: " + result)
        End Using
    End Sub
End Module

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono 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 ReadToEnd().

Aplica-se a