Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

BinaryWriter Class

Writes primitive types in binary to a stream and supports writing strings in a specific encoding.

System.Object
  System.IO.BinaryWriter

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

type BinaryWriter =  
    class 
        interface IDisposable 
    end

The BinaryWriter type exposes the following members.

  NameDescription
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryBinaryWriter()Initializes a new instance of the BinaryWriter class that writes to a stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryBinaryWriter(Stream)Initializes a new instance of the BinaryWriter class based on the specified stream and using UTF-8 encoding.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryBinaryWriter(Stream, Encoding)Initializes a new instance of the BinaryWriter class based on the specified stream and character encoding.
Public methodBinaryWriter(Stream, Encoding, Boolean)Initializes a new instance of the BinaryWriter 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 LibraryBaseStreamGets the underlying stream of the BinaryWriter.
Top

  NameDescription
Public methodSupported by the XNA FrameworkCloseCloses the current BinaryWriter and the underlying stream.
Public methodSupported by Portable Class LibraryDispose()Releases all resources used by the current instance of the BinaryWriter class.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryDispose(Boolean)Releases the unmanaged resources used by the BinaryWriter 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 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 LibraryFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying device.
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 LibrarySeekSets the position within the current stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Boolean)Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Byte)Writes an unsigned byte to the current stream and advances the stream position by one byte.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Byte[])Writes a byte array to the underlying stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char)Writes a Unicode character to the current stream and advances the current position of the stream in accordance with the Encoding used and the specific characters being written to the stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char[])Writes a character array to the current stream and advances the current position of the stream in accordance with the Encoding used and the specific characters being written to the stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Decimal)Writes a decimal value to the current stream and advances the stream position by sixteen bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Double)Writes an eight-byte floating-point value to the current stream and advances the stream position by eight bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Int16)Writes a two-byte signed integer to the current stream and advances the stream position by two bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Int32)Writes a four-byte signed integer to the current stream and advances the stream position by four bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Int64)Writes an eight-byte signed integer to the current stream and advances the stream position by eight bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(SByte)Writes a signed byte to the current stream and advances the stream position by one byte.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Single)Writes a four-byte floating-point value to the current stream and advances the stream position by four bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(String)Writes a length-prefixed string to this stream in the current encoding of the BinaryWriter, and advances the current position of the stream in accordance with the encoding used and the specific characters being written to the stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(UInt16)Writes a two-byte unsigned integer to the current stream and advances the stream position by two bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(UInt32)Writes a four-byte unsigned integer to the current stream and advances the stream position by four bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(UInt64)Writes an eight-byte unsigned integer to the current stream and advances the stream position by eight bytes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Byte[], Int32, Int32)Writes a region of a byte array to the current stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite(Char[], Int32, Int32)Writes a section of a character array to the current stream, and advances the current position of the stream in accordance with the Encoding used and perhaps the specific characters being written to the stream.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryWrite7BitEncodedIntWrites a 32-bit integer in a compressed format.
Top

  NameDescription
Public fieldStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryNullSpecifies a BinaryWriter with no backing store.
Protected fieldSupported by the XNA FrameworkSupported by Portable Class LibraryOutStreamHolds the underlying stream.
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIDisposable.DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Top

The BinaryWriter class provides methods that simplify writing primitive data types to a stream. For example, you can use the Write method to write a Boolean value to the stream as a one-byte value. The class includes write methods that support different data types.

When you create a new instance of the BinaryWriter class, you provide the stream to write to, and optionally specify the type of encoding and whether to leave the stream open after disposing the BinaryWriter 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.

A derived class can override the methods of this class to give unique character encodings.

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.

.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

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

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