StreamReader.ReadBlock Method

.NET Framework 4.5

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

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

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

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.

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 all input characters have been read.

ExceptionCondition
ArgumentNullException

buffer is null.

ArgumentException

The buffer length minus index is less than count.

ArgumentOutOfRangeException

index or count is negative.

ObjectDisposedException

The StreamReader is closed.

IOException

An I/O error occurred.

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

The method blocks until either count characters are read, or the end of the stream has been reached. This is a blocking version of Read.

.NET Framework

Supported in: 4.6, 4.5

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft