StreamReader.ReadBlockAsync Method

Definition

Overloads

ReadBlockAsync(Memory<Char>, CancellationToken)
ReadBlockAsync(Char[], Int32, Int32)

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)

public override System.Threading.Tasks.ValueTask<int> ReadBlockAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = null);
override this.ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Parameters

buffer
Memory<Char>
cancellationToken
CancellationToken

Returns

ReadBlockAsync(Char[], Int32, Int32)

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);
[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>
Public Overrides Function ReadBlockAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Parameters

buffer
Char[]

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

The position in buffer at which to begin writing.

count
Int32

The maximum number of characters to read. If the end of the stream is reached before the specified number of characters is written into the buffer, the method returns.

Returns

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of characters read into the buffer. 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.

Attributes

Exceptions

buffer is null.

index or count is negative.

The sum of index and count is larger than the buffer length.

The stream has been disposed.

The reader is currently in use by a previous read operation.

Remarks

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.

Applies to