This documentation is archived and is not being maintained.

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.

[Visual Basic]
Overrides Public Function ReadByte() As Integer
[C#]
public override int ReadByte();
[C++]
public: int ReadByte();
[JScript]
public override function ReadByte() : int;

Return Value

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

Exceptions

Exception Type Condition
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.

Remarks

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.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

BufferedStream Class | BufferedStream Members | System.IO Namespace | Working with I/O | Reading Text from a File | Writing Text to a File

Show: