Export (0) Print
Expand All

BufferedStream.ReadByte Method

Reads a byte from the underlying stream and returns the byte cast to an int, or returns -1 if reading from the end of the stream.

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)

public override int ReadByte ()
public int ReadByte ()
public override function ReadByte () : int
Not applicable.

Return Value

The byte cast to an int, or -1 if reading from the end of the stream.

Exception typeCondition

IOException

An I/O error occurs, such as the stream being closed.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

For an example of creating a file and writing text to a file, see Writing Text to a File. For an example of reading text from a file, see Reading Text from a File. For an example of reading from and writing to a binary file, see Reading and Writing to a Newly Created Data File.

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.

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft