System.IO.StringReader.ReadBlockAsync Method

Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

Syntax

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

Parameters

buffer
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
The position in buffer at which to begin writing.
count
The maximum number of characters to read. If the end of the string 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 bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the string has been reached.

Remarks

The task does not complete until either the number of characters specified by the count parameter are read, or the end of the string has been reached.

Requirements

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 4.0.0.0