Export (0) Print
Expand All

FileStream.ReadByte Method

Reads a byte from the file and advances the read position one byte.

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

abstract ReadByte : unit -> int  
override ReadByte : unit -> int

Return Value

Type: System.Int32
The byte, cast to an Int32, or -1 if the end of the stream has been reached.

ExceptionCondition
NotSupportedException

The current stream does not support reading.

ObjectDisposedException

The current stream is closed.

This method overrides ReadByte.

NoteNote

Use the CanRead property to determine whether the current instance supports reading. For additional information, see CanRead.

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.

For a list of common file and directory operations, see Common I/O Tasks.

The following code example shows how to write data to a file, byte by byte, and then verify that the data was written correctly.

No code example is currently available or this language may not be supported.

.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

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

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