StreamReader.ReadBlockAsync Metoda

Definicja

Przestrzeń nazw:

System.IO

Zestaw:

System.Runtime.dll

Przeciążenia

ReadBlockAsync(Memory<Char>, CancellationToken)	Asynchronicznie odczytuje znaki z bieżącego strumienia i zapisuje dane w buforze.
ReadBlockAsync(Char[], Int32, Int32)	Odczytuje określoną maksymalną liczbę znaków z bieżącego strumienia asynchronicznie i zapisuje dane w buforze, począwszy od określonego indeksu.

ReadBlockAsync(Memory<Char>, CancellationToken)

Źródło:

StreamReader.cs

Asynchronicznie odczytuje znaki z bieżącego strumienia i zapisuje dane w buforze.

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

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

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

Parametry

buffer

Memory<Char>

Gdy ta metoda zwraca wartość , zawiera określony blok pamięci znaków zastąpiony znakami odczytanych z bieżącego źródła.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Wartość domyślna to None.

Zwraca

ValueTask<Int32>

Zadanie wartości reprezentujące operację odczytu asynchronicznego. Wartość parametru typu zadania wartości zawiera całkowitą liczbę znaków odczytanych do buforu. Wartość wyniku może być mniejsza niż liczba żądanych znaków, jeśli liczba dostępnych znaków jest mniejsza niż żądana liczba lub może być równa 0 (zero), jeśli osiągnięto koniec strumienia.

Wyjątki

OperationCanceledException

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

ReadBlockAsync(Char[], Int32, Int32)

Źródło:

StreamReader.cs

Odczytuje określoną maksymalną liczbę znaków z bieżącego strumienia asynchronicznie i zapisuje dane w buforze, począwszy od określonego indeksu.

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

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

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

Public Overrides Function ReadBlockAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Parametry

buffer

Char[]

Gdy ta metoda zwraca wartość , zawiera określoną tablicę znaków z wartościami między index i (index + count - 1) zastąpionymi znakami odczytanymi z bieżącego źródła.

index

Int32

Pozycja, w buffer której należy rozpocząć pisanie.

count

Int32

Maksymalna liczba znaków do odczytania. Jeśli koniec strumienia zostanie osiągnięty przed zapisaną określoną liczbą znaków w buforze, metoda zwraca wartość .

Zwraca

Task<Int32>

Zadanie reprezentujące asynchroniczną operację odczytu. Wartość parametru TResult zawiera całkowitą liczbę znaków odczytanych do buforu. Wartość wyniku może być mniejsza niż liczba żądanych znaków, jeśli liczba dostępnych znaków jest mniejsza niż żądana liczba lub może być równa 0 (zero), jeśli osiągnięto koniec strumienia.

Wyjątki

ArgumentNullException

buffer to null.

ArgumentOutOfRangeException

index lub count jest ujemny.

ArgumentException

Suma index wartości i count jest większa niż długość buforu.

ObjectDisposedException

Strumień został usunięty.

InvalidOperationException

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

Uwagi

Zadanie nie zostanie ukończone do momentu odczytania liczby znaków określonych przez count parametr lub osiągnięcia końca strumienia.

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 ReadBlock(Char[], Int32, Int32)usługę .