StreamReader.ReadBlock Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Reads a specified maximum number of characters from the current stream and writes the data to a buffer, beginning at the specified index.
Assembly: mscorlib (in mscorlib.dll)
'Declaration Public Overrides Function ReadBlock ( _ 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.
Return Value
Type: System.Int32The 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.
| Exception | Condition |
|---|---|
| ArgumentNullException | buffer is Nothing. |
| 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.