Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
BinaryReader Class

BinaryReader Class

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

System.Object
  System.IO.BinaryReader

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

public class BinaryReader : IDisposable

The BinaryReader type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryBinaryReader(Stream)Initializes a new instance of the BinaryReader class based on the specified stream and using UTF-8 encoding.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryBinaryReader(Stream, Encoding)Initializes a new instance of the BinaryReader class based on the specified stream and character encoding.
Public methodBinaryReader(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.
Top

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryBaseStreamExposes access to the underlying stream of the BinaryReader.
Top

  NameDescription
Public methodSupported by the XNA FrameworkCloseCloses the current reader and the underlying stream.
Public methodSupported by Portable Class LibraryDispose()Releases all resources used by the current instance of the BinaryReader class.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryDispose(Boolean)Releases the unmanaged resources used by the BinaryReader class and optionally releases the managed resources.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFillBufferFills the internal buffer with the specified number of bytes read from the stream.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryPeekCharReturns the next available character and does not advance the byte or character position.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryRead()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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryRead(Byte[], Int32, Int32)Reads the specified number of bytes from the stream, starting from a specified point in the byte array.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryRead(Char[], Int32, Int32)Reads the specified number of characters from the stream, starting from a specified point in the character array.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryRead7BitEncodedIntReads in a 32-bit integer in compressed format.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadBooleanReads a Boolean value from the current stream and advances the current position of the stream by one byte.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadByteReads the next byte from the current stream and advances the current position of the stream by one byte.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadBytesReads the specified number of bytes from the current stream into a byte array and advances the current position by that number of bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadCharReads 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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadCharsReads 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 methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadDecimalReads a decimal value from the current stream and advances the current position of the stream by sixteen bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadDoubleReads an 8-byte floating point value from the current stream and advances the current position of the stream by eight bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadInt16Reads a 2-byte signed integer from the current stream and advances the current position of the stream by two bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadInt32Reads a 4-byte signed integer from the current stream and advances the current position of the stream by four bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadInt64Reads an 8-byte signed integer from the current stream and advances the current position of the stream by eight bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadSByteReads a signed byte from this stream and advances the current position of the stream by one byte.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadSingleReads a 4-byte floating point value from the current stream and advances the current position of the stream by four bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadStringReads a string from the current stream. The string is prefixed with the length, encoded as an integer seven bits at a time.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadUInt16Reads a 2-byte unsigned integer from the current stream using little-endian encoding and advances the position of the stream by two bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadUInt32Reads a 4-byte unsigned integer from the current stream and advances the position of the stream by four bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryReadUInt64Reads an 8-byte unsigned integer from the current stream and advances the position of the stream by eight bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIDisposable.DisposeReleases all resources used by the BinaryReader.
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.

Important noteImportant

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.

using System;
using System.IO;

class ConsoleApplication
{
    const string fileName = "AppSettings.dat";

    static void Main()
    {
        WriteDefaultValues();
        DisplayValues();
    }

    public static void WriteDefaultValues()
    {
        using (BinaryWriter writer = new BinaryWriter(File.Open(fileName, FileMode.Create)))
        {
            writer.Write(1.250F);
            writer.Write(@"c:\Temp");
            writer.Write(10);
            writer.Write(true);
        }
    }

    public static void DisplayValues()
    {
        float aspectRatio;
        string tempDirectory;
        int autoSaveTime;
        bool showStatusBar;

        if (File.Exists(fileName))
        {
            using (BinaryReader reader = new BinaryReader(File.Open(fileName, FileMode.Open)))
            {
                aspectRatio = reader.ReadSingle();
                tempDirectory = reader.ReadString();
                autoSaveTime = reader.ReadInt32();
                showStatusBar = reader.ReadBoolean();
            }

            Console.WriteLine("Aspect ratio set to: " + aspectRatio);
            Console.WriteLine("Temp directory is: " + tempDirectory);
            Console.WriteLine("Auto save time set to: " + autoSaveTime);
            Console.WriteLine("Show status bar: " + showStatusBar);
        }
    }
}

.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

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library

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:
© 2015 Microsoft