StreamReader.ReadLineAsync Metoda

Definice

Obor názvů:

System.IO

Sestavení:

System.Runtime.dll

Přetížení

ReadLineAsync()	Čte asynchronně řádek znaků z aktuálního datového proudu a vrátí data jako řetězec.
ReadLineAsync(CancellationToken)	Čte asynchronně řádek znaků z aktuálního datového proudu a vrátí data jako řetězec.

ReadLineAsync()

Zdroj:

StreamReader.cs

Čte asynchronně řádek znaků z aktuálního datového proudu a vrátí data jako řetězec.

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)

Návraty

Task<String>

Úloha, která představuje asynchronní operaci čtení. Hodnota parametru TResult obsahuje další řádek z datového proudu nebo je null , pokud byly přečtené všechny znaky.

Výjimky

ArgumentOutOfRangeException

Počet znaků na dalším řádku je větší než Int32.MaxValue.

ObjectDisposedException

Datový proud byl odstraněn.

InvalidOperationException

Čtečka je aktuálně používána předchozí operací čtení.

Příklady

Následující příklad ukazuje, jak číst první řádek souboru pomocí 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

Poznámky

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem ReadLine().

ReadLineAsync(CancellationToken)

Zdroj:

StreamReader.cs

Čte asynchronně řádek znaků z aktuálního datového proudu a vrátí data jako řetězec.

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, který se má monitorovat pro žádosti o zrušení.

Návraty

ValueTask<String>

Úloha hodnoty, která představuje asynchronní operaci čtení. Hodnota parametru TResult obsahuje další řádek z datového proudu nebo pokud null byly přečtené všechny znaky.

Výjimky

ArgumentOutOfRangeException

Počet znaků na dalším řádku je větší než Int32.MaxValue.

ObjectDisposedException

Čtečka streamu byla odstraněna.

InvalidOperationException

Čtečka je aktuálně používána předchozí operací čtení.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Pokud je tato metoda zrušena prostřednictvím cancellationTokennástroje , mohou být ztracena některá data, která byla načtena z aktuálního Stream , ale nebyla uložena (uživatelem StreamReader) nebo vrácena (volajícímu).

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem ReadLine().