BinaryReader Class

July 28, 2014

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

System.Object
  System.IO.BinaryReader

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

public class BinaryReader : IDisposable

The BinaryReader type exposes the following members.

  NameDescription
Public methodBinaryReader(Stream)Initializes a new instance of the BinaryReader class based on the supplied stream and using UTF8Encoding.
Public methodBinaryReader(Stream, Encoding)Initializes a new instance of the BinaryReader class based on the supplied stream and a specific character encoding.
Public methodBinaryReader(Stream, Encoding, Boolean)Initializes a new instance of the BinaryReader class based on the supplied stream, a specific character encoding, and a value that specifies whether to leave the stream open.
Top

  NameDescription
Public propertyBaseStreamExposes access to the underlying stream of the BinaryReader.
Top

  NameDescription
Public methodCloseCloses the current reader and the underlying stream.
Public methodDispose()Releases the resources used by the current instance of the BinaryReader class.
Protected methodDispose(Boolean)Called by the Dispose method and finalizer to release the managed and unmanaged resources used by the current instance of the BinaryReader class.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFillBufferFills the internal buffer with the specified number of bytes read from the stream.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPeekCharReturns the next available character and does not advance the byte or character position.
Public methodRead()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.
Public methodRead(Byte[], Int32, Int32)Reads count bytes from the stream with index as the starting point in the byte array.
Public methodRead(Char[], Int32, Int32)Reads count characters from the stream with index as the starting point in the character array.
Protected methodRead7BitEncodedIntReads in a 32-bit integer in compressed format.
Public methodReadBooleanReads a Boolean value from the current stream and advances the current position of the stream by one byte.
Public methodReadByteReads the next byte from the current stream and advances the current position of the stream by one byte.
Public methodReadBytesReads the specified number of bytes from the current stream into a byte array and advances the current position by that number of bytes.
Public methodReadCharReads 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.
Public methodReadCharsReads 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.
Public methodReadDecimalReads a decimal value from the current stream and advances the current position of the stream by sixteen bytes.
Public methodReadDoubleReads an 8-byte floating point value from the current stream and advances the current position of the stream by eight bytes.
Public methodReadInt16Reads a 2-byte signed integer from the current stream and advances the current position of the stream by two bytes.
Public methodReadInt32Reads a 4-byte signed integer from the current stream and advances the current position of the stream by four bytes.
Public methodReadInt64Reads an 8-byte signed integer from the current stream and advances the current position of the stream by eight bytes.
Public methodReadSByteReads a signed byte from this stream and advances the current position of the stream by one byte.
Public methodReadSingleReads a 4-byte floating point value from the current stream and advances the current position of the stream by four bytes.
Public methodReadStringReads a string from the current stream. The string is prefixed with the length, encoded as an integer seven bits at a time.
Public methodReadUInt16Reads a 2-byte unsigned integer from the current stream using little-endian encoding and advances the position of the stream by two bytes.
Public methodReadUInt32Reads a 4-byte unsigned integer from the current stream and advances the position of the stream by four bytes.
Public methodReadUInt64Reads an 8-byte unsigned integer from the current stream and advances the position of the stream by eight bytes.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

Show:
© 2014 Microsoft