StreamReader.ReadToEndAsync Método

Definição

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

Sobrecargas

Name Description
ReadToEndAsync()

Lê todos os caracteres da posição atual até ao fim do fluxo de forma assíncrona e devolve-os como uma única cadeia.
ReadToEndAsync(CancellationToken)

Lê todos os caracteres da posição atual até ao fim do fluxo de forma assíncrona e devolve-os como uma única cadeia.

ReadToEndAsync()

Origem:
StreamReader.cs
Origem:
StreamReader.cs
Origem:
StreamReader.cs
Origem:
StreamReader.cs
Origem:
StreamReader.cs

Lê todos os caracteres da posição atual até ao fim do fluxo de forma assíncrona e devolve-os como uma única cadeia.

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)

Devoluções

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 desde a posição atual até ao fim do fluxo.

Atributos
ComVisibleAttribute

Exceções

ArgumentOutOfRangeException

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

ObjectDisposedException

O riacho foi eliminado.

InvalidOperationException

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

Exemplos

O exemplo seguinte mostra como ler o conteúdo de um ficheiro 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

Observações

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

Aplica-se a

ReadToEndAsync(CancellationToken)

Origem:
StreamReader.cs
Origem:
StreamReader.cs
Origem:
StreamReader.cs
Origem:
StreamReader.cs
Origem:
StreamReader.cs

Lê todos os caracteres da posição atual até ao fim do fluxo de forma assíncrona e devolve-os como uma única cadeia.

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync(System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<string> ReadToEndAsync(System.Threading.CancellationToken cancellationToken);
override this.ReadToEndAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
Public Overrides Function ReadToEndAsync (cancellationToken As CancellationToken) As Task(Of String)

Parâmetros

cancellationToken
CancellationToken

O token para monitorizar pedidos de cancelamento.

Devoluções

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 desde a posição atual até ao fim do fluxo.

Exceções

ArgumentOutOfRangeException

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

ObjectDisposedException

O leitor de stream foi descartado.

InvalidOperationException

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

OperationCanceledException

O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.

Observações

Se este método for cancelado via cancellationToken, alguns dados que foram lidos da corrente Stream mas não armazenados (pelo StreamReader) ou devolvidos (ao chamador) podem ser perdidos.

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

Aplica-se a