StreamReader.Read Method (Char, Int32, Int32)
Updated: December 2010
Reads a specified maximum number of characters from the current stream into a buffer, beginning at the specified index.
Assembly: mscorlib (in mscorlib.dll)
public override function Read( buffer : char, index : int, count : int ) : int
- 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.
- Type: System.Int32
The index of buffer at which to begin writing.
- Type: System.Int32
The maximum number of characters to read.
Return ValueType: System.Int32
The number of characters that have been read, or 0 if at the end of the stream and no data was read. The number will be less than or equal to the count parameter, depending on whether the data is available within the stream.
This method overrides Read.
This method returns an integer so that it can return 0 if the end of the stream has been reached.
When using the Read method, it is more efficient to use a buffer that is the same size as the internal buffer of the stream, where the internal buffer is set to your desired block size, and to always read less than the block size. If the size of the internal buffer was unspecified when the stream was constructed, its default size is 4 kilobytes (4096 bytes). If you manipulate the position of the underlying stream after reading data into the buffer, the position of the underlying stream might not match the position of the internal buffer. To reset the internal buffer, call the DiscardBufferedData method; however, this method slows performance and should be called only when absolutely necessary.
For a list of common I/O tasks, see Common I/O Tasks.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.