When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
public override int Read( byte[] buffer, int offset, int count )
Public Overrides Function Read ( _ <OutAttribute> buffer As Byte(), _ offset As Integer, _ count As Integer _ ) As Integer
public: virtual int Read( [InAttribute] [OutAttribute] array<unsigned char>^ buffer, int offset, int count ) override
public int Read( /** @attribute InAttribute */ /** @attribute OutAttribute */ byte[] buffer, int offset, int count )
Parameters
- buffer (array<Byte>[]()[][])
- An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
- offset (Int32)
- The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
- count (Int32)
- The maximum number of bytes to be read from the current stream.
Return Value
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
Exceptions
Exception | Condition |
---|---|
ArgumentException | The sum of offset and count is larger than the buffer length.
|
ArgumentNullException | buffer is null.
|
ArgumentOutOfRangeException | offset or count is negative.
|
IOException | An I/O error occurs.
|
NotSupportedException | The stream does not support reading.
|
ObjectDisposedException | Methods were called after the stream was closed.
|