Windows apps
Collapse the table of content
Expand the table of content
Information
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.

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)

public virtual int Read (
	[InAttribute] [OutAttribute] char[] buffer,
	int index,
	int count
)
public int Read (
	/** @attribute InAttribute() */ /** @attribute OutAttribute() */ char[] buffer, 
	int index, 
	int count
)
public function Read (
	buffer : char[], 
	index : int, 
	count : int
) : int
Not applicable.

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 place in buffer at which to begin writing.

count

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

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.

Exception typeCondition

ArgumentNullException

buffer is a null reference (Nothing in Visual Basic).

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.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

Show:
© 2016 Microsoft