Export (0) Print
Expand All

Stream::ReadByte Method

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)

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.

ExceptionCondition
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.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft