BinaryReader Class

 

Reads primitive data types as binary values in a specific encoding.

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

System.Object
  System.IO.BinaryReader

[<ComVisibleAttribute(true)>]
type BinaryReader = 
    class
        interface IDisposable
    end

NameDescription
System_CAPS_pubmethodBinaryReader(Stream)

Initializes a new instance of the BinaryReader class based on the specified stream and using UTF-8 encoding.

System_CAPS_pubmethodBinaryReader(Stream, Encoding)

Initializes a new instance of the BinaryReader class based on the specified stream and character encoding.

System_CAPS_pubmethodBinaryReader(Stream, Encoding, Boolean)

Initializes a new instance of the BinaryReader class based on the specified stream and character encoding, and optionally leaves the stream open.

NameDescription
System_CAPS_pubpropertyBaseStream

Exposes access to the underlying stream of the BinaryReader.

NameDescription
System_CAPS_pubmethodClose()

Closes the current reader and the underlying stream.

System_CAPS_pubmethodDispose()

Releases all resources used by the current instance of the BinaryReader class.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the BinaryReader class and optionally releases the managed resources.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFillBuffer(Int32)

Fills the internal buffer with the specified number of bytes read from the stream.

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodPeekChar()

Returns the next available character and does not advance the byte or character position.

System_CAPS_pubmethodRead()

Reads characters from the underlying stream and advances the current position of the stream in accordance with the Encoding used and the specific character being read from the stream.

System_CAPS_pubmethodRead(Byte[], Int32, Int32)

Reads the specified number of bytes from the stream, starting from a specified point in the byte array.

System_CAPS_pubmethodRead(Char[], Int32, Int32)

Reads the specified number of characters from the stream, starting from a specified point in the character array.

System_CAPS_protmethodRead7BitEncodedInt()

Reads in a 32-bit integer in compressed format.

System_CAPS_pubmethodReadBoolean()

Reads a Boolean value from the current stream and advances the current position of the stream by one byte.

System_CAPS_pubmethodReadByte()

Reads the next byte from the current stream and advances the current position of the stream by one byte.

System_CAPS_pubmethodReadBytes(Int32)

Reads the specified number of bytes from the current stream into a byte array and advances the current position by that number of bytes.

System_CAPS_pubmethodReadChar()

Reads the next character from the current stream and advances the current position of the stream in accordance with the Encoding used and the specific character being read from the stream.

System_CAPS_pubmethodReadChars(Int32)

Reads the specified number of characters from the current stream, returns the data in a character array, and advances the current position in accordance with the Encoding used and the specific character being read from the stream.

System_CAPS_pubmethodReadDecimal()

Reads a decimal value from the current stream and advances the current position of the stream by sixteen bytes.

System_CAPS_pubmethodReadDouble()

Reads an 8-byte floating point value from the current stream and advances the current position of the stream by eight bytes.

System_CAPS_pubmethodReadInt16()

Reads a 2-byte signed integer from the current stream and advances the current position of the stream by two bytes.

System_CAPS_pubmethodReadInt32()

Reads a 4-byte signed integer from the current stream and advances the current position of the stream by four bytes.

System_CAPS_pubmethodReadInt64()

Reads an 8-byte signed integer from the current stream and advances the current position of the stream by eight bytes.

System_CAPS_pubmethodReadSByte()

Reads a signed byte from this stream and advances the current position of the stream by one byte.

System_CAPS_pubmethodReadSingle()

Reads a 4-byte floating point value from the current stream and advances the current position of the stream by four bytes.

System_CAPS_pubmethodReadString()

Reads a string from the current stream. The string is prefixed with the length, encoded as an integer seven bits at a time.

System_CAPS_pubmethodReadUInt16()

Reads a 2-byte unsigned integer from the current stream using little-endian encoding and advances the position of the stream by two bytes.

System_CAPS_pubmethodReadUInt32()

Reads a 4-byte unsigned integer from the current stream and advances the position of the stream by four bytes.

System_CAPS_pubmethodReadUInt64()

Reads an 8-byte unsigned integer from the current stream and advances the position of the stream by eight bytes.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The BinaryReader class provides methods that simplify reading primitive data types from a stream. For example, you can use the ReadBoolean method to read the next byte as a Boolean value and advance the current position in the stream by one byte. The class includes read methods that support different data types.

When you create a new instance of the BinaryReader class, you provide the stream to read from, and optionally specify the type of encoding and whether to leave the stream open after disposing the BinaryReader object. If you do not specify an encoding type, UTF-8 is used.

System_CAPS_importantImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

The following code example demonstrates how to store and retrieve application settings in a file.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: