StringReader.ReadToEndAsync Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Sobrecargas

ReadToEndAsync()	Lê todos os caracteres da posição atual até o final da cadeia de caracteres de forma assíncrona e os retorna como uma única cadeia de caracteres.
ReadToEndAsync(CancellationToken)	Lê todos os caracteres da posição atual até o final da cadeia de caracteres de forma assíncrona e os retorna como uma única cadeia de caracteres.

ReadToEndAsync()

Origem:

StringReader.cs

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

public:
 override System::Threading::Tasks::Task<System::String ^> ^ ReadToEndAsync();

public override System.Threading.Tasks.Task<string> ReadToEndAsync ();

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 parâmetro TResult contém uma cadeia de caracteres com os caracteres da posição atual até o final da cadeia de caracteres.

Exceções

ArgumentOutOfRangeException

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

ObjectDisposedException

O leitor de cadeia de caracteres foi descartado.

InvalidOperationException

O leitor está sendo usado no momento por uma operação de leitura anterior.

Exemplos

O exemplo a seguir mostra como ler uma cadeia de caracteres inteira de forma assíncrona.

using System;
using System.IO;
using System.Text;

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

        static async void ReadCharacters()
        {
            StringBuilder stringToRead = new StringBuilder();
            stringToRead.AppendLine("Characters in 1st line to read");
            stringToRead.AppendLine("and 2nd line");
            stringToRead.AppendLine("and the end");

            using (StringReader reader = new StringReader(stringToRead.ToString()))
            {
                string readText = await reader.ReadToEndAsync();
                Console.WriteLine(readText);
            }
        }
    }
}
// The example displays the following output:
//
// Characters in 1st line to read
// and 2nd line
// and the end
//

Imports System.IO
Imports System.Text

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = New StringBuilder()
        stringToRead.AppendLine("Characters in 1st line to read")
        stringToRead.AppendLine("and 2nd line")
        stringToRead.AppendLine("and the end")

        Using reader As StringReader = New StringReader(stringToRead.ToString())
            Dim readText As String = Await reader.ReadToEndAsync()
            Console.WriteLine(readText)
        End Using
    End Sub
End Module
' The example displays the following output:
'
' Characters in 1st line to read
' and 2nd line
' and the end
'

Comentários

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

ReadToEndAsync(CancellationToken)

Origem:

StringReader.cs

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

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 a se monitorar para solicitações de cancelamento.

Retornos

Task<String>

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

Exceções

ArgumentOutOfRangeException

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

ObjectDisposedException

O leitor de cadeia de caracteres foi descartado.

InvalidOperationException

O leitor está sendo usado no momento por uma operação de leitura anterior.

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

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