System.IO.TextReader.Read Method

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

Syntax

public virtual int Read (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 reader is reached before the specified number of characters is read into the buffer, the method returns.

Returns

The number of characters that have been read. The number will be less than or equal to count, depending on whether the data is available within the reader. This method returns 0 (zero) if it is called when no more characters are left to read.

Exceptions

TypeReason
ArgumentNullException buffer is null.
ArgumentException(index + count ) > buffer.Length.
ArgumentOutOfRangeException

index < 0

- or-

count < 0.

System.IO.IOExceptionAn I/O error occurred.

Remarks

This method returns after either count characters are read or the end of the file is reached. TextReader.ReadBlock(Char[], int, int) is a blocking version of this method.

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.Read(Char[], int, int) method, see the StreamReader.Read(Char[], int, int) method.

Requirements

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