Stream.ReadByte Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
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.
Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Overridable Function ReadByte As Integer
public virtual int ReadByte()
Return Value
Type: System.Int32
The unsigned byte cast to an Int32, or -1 if at the end of the stream.
Exceptions
| Exception | Condition |
|---|---|
| NotSupportedException | The stream does not support reading. |
| ObjectDisposedException | Methods were called after the stream was closed. |
Remarks
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.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.