StreamReader.ReadBlockAsync Metoda

Definicja

Przeciążenia

ReadBlockAsync(Memory<Char>, CancellationToken)

Asynchronicznie odczytuje znaki z bieżącego strumienia i zapisuje je w buforze.Asynchronously reads the characters from the current stream and writes the data to a buffer.

ReadBlockAsync(Char[], Int32, Int32)

Odczytuje określoną maksymalną liczbę znaków z bieżącego strumienia asynchronicznie i zapisuje dane w buforze, rozpoczynając od określonego indeksu.Reads a specified maximum number of characters from the current stream asynchronously and writes the data to a buffer, beginning at the specified index.

ReadBlockAsync(Memory<Char>, CancellationToken)

Asynchronicznie odczytuje znaki z bieżącego strumienia i zapisuje je w buforze.Asynchronously reads the characters from the current stream and writes the data to a buffer.

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, zawiera określony blok pamięci znaków zastępowanych przez znaki odczytywane z bieżącego źródła.When this method returns, contains the specified memory block of characters replaced by the characters read from the current source.

cancellationToken
CancellationToken

Token do monitorowania żądań anulowania.The token to monitor for cancellation requests. Wartość domyślna to None.The default value is None.

Zwraca

ValueTask<Int32>

Zadanie wartości, które reprezentuje asynchroniczną operację odczytu.A value task that represents the asynchronous read operation. Wartość parametru typu zadania zawiera łączną liczbę znaków odczytywanych w buforze.The value of the type parameter of the value task contains the total number of characters read into the buffer. Wartość wynikowa może być mniejsza niż liczba żądanych znaków, jeśli liczba aktualnie dostępnych znaków jest mniejsza niż żądana liczba, lub może być równa 0 (zero), jeśli osiągnięto koniec strumienia.The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Dotyczy

ReadBlockAsync(Char[], Int32, Int32)

Odczytuje określoną maksymalną liczbę znaków z bieżącego strumienia asynchronicznie i zapisuje dane w buforze, rozpoczynając od określonego indeksu.Reads a specified maximum number of characters from the current stream asynchronously and writes the data to a buffer, beginning at the specified index.

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);
[System.Runtime.InteropServices.ComVisible(false)]
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>
[<System.Runtime.InteropServices.ComVisible(false)>]
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, zawiera określoną tablicę znaków z wartościami między index i ( index + count -1) zastąpione przez znaki odczytane z bieżącego źródła.When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.

index
Int32

Położenie, w buffer którym rozpocznie się zapisywanie.The position in buffer at which to begin writing.

count
Int32

Maksymalna liczba znaków do odczytania.The maximum number of characters to read. Jeśli osiągnięto koniec strumienia przed określoną liczbą znaków w buforze, metoda zwraca.If the end of the stream is reached before the specified number of characters is written into the buffer, the method returns.

Zwraca

Task<Int32>

Zadanie, które reprezentuje asynchroniczną operację odczytu.A task that represents the asynchronous read operation. Wartość TResult parametru zawiera łączną liczbę znaków odczytywanych w buforze.The value of the TResult parameter contains the total number of characters read into the buffer. Wartość wynikowa może być mniejsza niż liczba żądanych znaków, jeśli liczba aktualnie dostępnych znaków jest mniejsza niż żądana liczba, lub może być równa 0 (zero), jeśli osiągnięto koniec strumienia.The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Atrybuty

Wyjątki

buffer to null.buffer is null.

index lub count jest ujemna.index or count is negative.

Suma index i count jest większa niż długość buforu.The sum of index and count is larger than the buffer length.

Strumień został usunięty.The stream has been disposed.

Czytnik jest obecnie używany przez poprzednią operację odczytu.The reader is currently in use by a previous read operation.

Uwagi

Zadanie nie zostanie ukończone, dopóki nie zostanie odczytana liczba znaków określona przez count parametr lub osiągnięto koniec strumienia.The task does not complete until either the number of characters specified by the count parameter are read, or the end of the stream has been reached.

Dotyczy