System.IO.TextReader.ReadBlock Method

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

Syntax

public virtual int ReadBlock (char[] buffer, int index, int count)

Parameters

buffer
When this method returns, this parameter 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.

Returns

The number of characters that have been read. The number will be less than or equal to count, depending on whether all input characters have been read.

Exceptions

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

index < 0

- or-

count < 0.

System.IO.IOException An I/O error occurred.

Remarks

The position of the underlying text reader is advanced by the number of characters that were read into buffer.

The method blocks until either count characters are read, or all characters have been read. This is a blocking version of TextReader.Read.

Requirements

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