StreamReader.ReadLineAsync Metoda

Definicja

Przestrzeń nazw:

System.IO

Zestaw:

System.Runtime.dll

Przeciążenia

ReadLineAsync()	Odczytuje wiersz znaków asynchronicznie z bieżącego strumienia i zwraca dane jako ciąg.
ReadLineAsync(CancellationToken)	Odczytuje wiersz znaków asynchronicznie z bieżącego strumienia i zwraca dane jako ciąg.

ReadLineAsync()

Źródło:

StreamReader.cs

Odczytuje wiersz znaków asynchronicznie z bieżącego strumienia i zwraca dane jako ciąg.

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)

Zwraca

Task<String>

Zadanie reprezentujące asynchroniczną operację odczytu. Wartość parametru TResult zawiera następny wiersz ze strumienia lub określa null , czy wszystkie znaki zostały odczytane.

Wyjątki

ArgumentOutOfRangeException

Liczba znaków w następnym wierszu jest większa niż Int32.MaxValue.

ObjectDisposedException

Strumień został usunięty.

InvalidOperationException

Czytnik jest obecnie używany przez poprzednią operację odczytu.

Przykłady

W poniższym przykładzie pokazano, jak odczytać pierwszy wiersz pliku przy użyciu ReadLineAsync() metody .

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

Uwagi

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez ReadLine()usługę .

ReadLineAsync(CancellationToken)

Źródło:

StreamReader.cs

Odczytuje wiersz znaków asynchronicznie z bieżącego strumienia i zwraca dane jako ciąg.

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)

Parametry

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania.

Zwraca

ValueTask<String>

Zadanie wartości reprezentujące operację odczytu asynchronicznego. Wartość parametru TResult zawiera następny wiersz ze strumienia lub określa null , czy wszystkie znaki zostały odczytane.

Wyjątki

ArgumentOutOfRangeException

Liczba znaków w następnym wierszu jest większa niż Int32.MaxValue.

ObjectDisposedException

Czytnik strumienia został usunięty.

InvalidOperationException

Czytnik jest obecnie używany przez poprzednią operację odczytu.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Jeśli ta metoda zostanie anulowana za pośrednictwem cancellationTokenmetody , niektóre dane, które zostały odczytane z bieżącej Stream , ale nie są przechowywane (przez StreamReaderelement ) lub zwracane (do obiektu wywołującego) mogą zostać utracone.

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez ReadLine()usługę .