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 text is reached before the specified number of characters is read into the buffer, the current 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 text has been reached.

Remarks

The task completes after either the number of characters specified by the count parameter are read or the end of the file is reached.

The System.IO.TextReader class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the TextReader.ReadAsync(Char[], int, int) method, see the StreamReader.ReadAsync(Char[], int, int) method.

Requirements