StreamReader.ReadLineAsync Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Sobrecargas

ReadLineAsync()	Lê uma linha de caracteres assincronamente do fluxo atual e retorna os dados como uma cadeia de caracteres.
ReadLineAsync(CancellationToken)	Lê uma linha de caracteres assincronamente do fluxo atual e retorna os dados como uma cadeia de caracteres.

ReadLineAsync()

Origem:

StreamReader.cs

Lê uma linha de caracteres assincronamente do fluxo atual e retorna os dados como uma cadeia de caracteres.

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

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

override this.ReadLineAsync : unit -> System.Threading.Tasks.Task<string>

Public Overrides Function ReadLineAsync () 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 a próxima linha do fluxo ou null se todos os caracteres tiverem sido lidos.

Exceções

ArgumentOutOfRangeException

O número de caracteres na próxima linha é maior que Int32.MaxValue.

ObjectDisposedException

O fluxo 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 a primeira linha de um arquivo usando o ReadLineAsync() 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.ReadLineAsync();
                Console.WriteLine("First line 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.ReadLineAsync()
            Console.WriteLine("First line 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 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 ReadLine().

ReadLineAsync(CancellationToken)

Origem:

StreamReader.cs

Lê uma linha de caracteres assincronamente do fluxo atual e retorna os dados como uma cadeia de caracteres.

public:
 override System::Threading::Tasks::ValueTask<System::String ^> ReadLineAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.ValueTask<string?> ReadLineAsync (System.Threading.CancellationToken cancellationToken);

override this.ReadLineAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<string>

Public Overrides Function ReadLineAsync (cancellationToken As CancellationToken) As ValueTask(Of String)

Parâmetros

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento.

Retornos

ValueTask<String>

Uma tarefa de valor que representa a operação de leitura assíncrona. O valor do TResult parâmetro contém a próxima linha do fluxo ou se null todos os caracteres foram lidos.

Exceções

ArgumentOutOfRangeException

O número de caracteres na próxima linha é maior que Int32.MaxValue.

ObjectDisposedException

O leitor de fluxo 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

Se esse método for cancelado por meio cancellationTokende , alguns dados que foram lidos do atual Stream , mas não armazenados (pelo StreamReader) ou retornados (para o chamador) poderão ser perdidos.

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