TextReader.ReadAsync Metoda

Definice

Obor názvů:

System.IO

Sestavení:

System.Runtime.dll

Přetížení

ReadAsync(Memory<Char>, CancellationToken)	Asynchronně přečte znaky z aktuálního datového proudu do bloku paměti.
ReadAsync(Char[], Int32, Int32)	Přečte asynchronně zadaný maximální počet znaků z aktuální čtečky textu a zapíše data do vyrovnávací paměti počínaje zadaným indexem.

ReadAsync(Memory<Char>, CancellationToken)

Zdroj:

TextReader.cs

Asynchronně přečte znaky z aktuálního datového proudu do bloku paměti.

public virtual System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overridable Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parametry

buffer

Memory<Char>

Když tato metoda vrátí, obsahuje zadaný paměťový blok znaků nahrazen znaky přečtené z aktuálního zdroje.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

ValueTask<Int32>

Úloha hodnoty, která představuje asynchronní operaci čtení. Hodnota parametru type obsahuje počet znaků, které byly přečtené, nebo 0, pokud se na konci datového proudu nenačetla žádná data. Číslo bude menší nebo se bude rovnat buffer délce v závislosti na tom, jestli jsou data dostupná v datovém proudu.

Výjimky

OperationCanceledException

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

ReadAsync(Char[], Int32, Int32)

Zdroj:

TextReader.cs

Přečte asynchronně zadaný maximální počet znaků z aktuální čtečky textu a zapíše data do vyrovnávací paměti počínaje zadaným indexem.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);

public virtual System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);

abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>

Public Overridable Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Parametry

buffer

Char[]

Když tato metoda vrátí, obsahuje zadané pole znaků s hodnotami mezi index a (index + count - 1) nahrazené znaky přečtenými z aktuálního zdroje.

index

Int32

Pozice, ve buffer které se má začít psát.

count

Int32

Maximální počet znaků, které se mají přečíst. Pokud je dosaženo konce textu před načtením zadaného počtu znaků do vyrovnávací paměti, aktuální metoda vrátí.

Návraty

Task<Int32>

Úloha, která představuje asynchronní operaci čtení. Hodnota parametru TResult obsahuje celkový počet bajtů načtených do vyrovnávací paměti. Výsledná hodnota může být menší než požadovaný počet bajtů, pokud je počet aktuálně dostupných bajtů menší než požadované číslo, nebo může být 0 (nula), pokud bylo dosaženo konce textu.

Výjimky

ArgumentNullException

buffer je null.

ArgumentOutOfRangeException

index nebo count je negativní.

ArgumentException

Součet index a count je větší než délka vyrovnávací paměti.

ObjectDisposedException

Čtečka textu byla odstraněna.

InvalidOperationException

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

Poznámky

Úkol se dokončí po přečtení počtu znaků určených parametrem count nebo dosažení konce souboru.

Třída TextReader je abstraktní třída. Proto ji v kódu nevytvořujete. Příklad použití ReadAsync metody najdete v StreamReader.ReadAsync metodě .

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 Read(Char[], Int32, Int32).

Viz také

• ReadAsync(Char[], Int32, Int32)
• ReadAsync(Char[], Int32, Int32)
• Vstupně-výstupní operace souborů a datových proudů
• Postupy: Čtení textu ze souboru
• Postupy: Zápis textu do souboru