MSDN Library

The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

1 out of 3 rated this helpful - Rate this topic

TextReader.ReadBlock Method

.NET Framework 4

Other Versions

Reads a maximum of count characters from the current stream, and writes the data to buffer, beginning at index.

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

Syntax

C++

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

Parameters

buffer: Type: System.Char[]
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: Type: System.Int32
The position in buffer at which to begin writing.

count: Type: System.Int32
The maximum number of characters to read.

Return Value

Type: System.Int32
The position of the underlying stream is advanced by the number of characters that were read into buffer.
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

Exception	Condition
ArgumentNullException	buffer is null.
ArgumentException	The buffer length minus index is less than count.
ArgumentOutOfRangeException	index or count is negative.
ObjectDisposedException	The TextReader is closed.
IOException	An I/O error occurs.

Remarks

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

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.