Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
Assembly: mscorlib (in mscorlib.dll)
Public Overridable Function ReadByte As Integer
public virtual int ReadByte()
public: virtual int ReadByte()
abstract ReadByte : unit -> int override ReadByte : unit -> int
Return Value
Type: System.Int32The unsigned byte cast to an Int32, or -1 if at the end of the stream.
| Exception | Condition |
|---|---|
| NotSupportedException |
The stream does not support reading. |
| ObjectDisposedException |
Methods were called after the stream was closed. |
Use the CanRead property to determine whether the current instance supports reading.
Attempts to manipulate the stream after the stream has been closed could throw an ObjectDisposedException.
Notes to Implementers
The default implementation on Stream creates a new single-byte array and then calls Read. While this is formally correct, it is inefficient. Any stream with an internal buffer should override this method and provide a much more efficient version that reads the buffer directly, avoiding the extra array allocation on every call.
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Portable Class Library
Supported in: Portable Class LibraryWindows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.