This documentation is archived and is not being maintained.

TextReader.Read Method (Char(), Int32, Int32)

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)

'Declaration
Public Overridable Function Read ( _
	<OutAttribute> buffer As Char(), _
	index As Integer, _
	count As Integer _
) As Integer

Parameters

buffer
Type: System.Char()
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
Type: System.Int32
The position in buffer at which to begin writing.
count
Type: System.Int32
The maximum number of characters to read. If the end of the stream is reached before count of characters is read into buffer, the current method returns.

Return Value

Type: System.Int32
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 stream. This method returns zero if called when no more characters are left to read.

ExceptionCondition
ArgumentNullException

buffer is Nothing.

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.

This method returns after either count characters are read or the end of the file is reached. ReadBlock is a blocking version of this method.

.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

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.
Show: