BinaryWriter Class

May 11, 2014

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

System.Object
  System.IO.BinaryWriter

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

public class BinaryWriter : IDisposable

The BinaryWriter type exposes the following members.

  NameDescription
Protected methodBinaryWriter()Initializes a new instance of the BinaryWriter class that writes to a stream.
Public methodBinaryWriter(Stream)Initializes a new instance of the BinaryWriter class based on the supplied stream and using UTF-8 as the encoding for strings.
Public methodBinaryWriter(Stream, Encoding)Initializes a new instance of the BinaryWriter class based on the supplied stream and a specific character encoding.
Public methodBinaryWriter(Stream, Encoding, Boolean)Initializes a new instance of the BinaryWriter class based on the supplied stream, a specific character encoding, and a value that specifies whether to leave the stream open.
Top

  NameDescription
Public propertyBaseStreamGets the underlying stream of the BinaryWriter.
Top

  NameDescription
Public methodCloseCloses the current BinaryWriter and the underlying stream.
Public methodDispose()Releases the resources used by the current instance of the BinaryWriter 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 BinaryWriter class.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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 methodFlushClears all buffers for the current writer and causes any buffered data to be written to the underlying device.
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 methodSeekSets the position within the current stream.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWrite(Boolean)Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true.
Public methodWrite(Byte)Writes an unsigned byte to the current stream and advances the stream position by one byte.
Public methodWrite(Byte[])Writes a byte array to the underlying stream.
Public methodWrite(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 methodWrite(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 methodWrite(Decimal)Writes a decimal value to the current stream and advances the stream position by sixteen bytes.
Public methodWrite(Double)Writes an eight-byte floating-point value to the current stream and advances the stream position by eight bytes.
Public methodWrite(Int16)Writes a two-byte signed integer to the current stream and advances the stream position by two bytes.
Public methodWrite(Int32)Writes a four-byte signed integer to the current stream and advances the stream position by four bytes.
Public methodWrite(Int64)Writes an eight-byte unsigned integer to the current stream and advances the stream position by eight bytes.
Public methodWrite(SByte)Writes a signed byte to the current stream and advances the stream position by one byte.
Public methodWrite(Single)Writes a four-byte floating-point value to the current stream and advances the stream position by four bytes.
Public methodWrite(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 methodWrite(UInt16)Writes a two-byte unsigned integer to the current stream and advances the stream position by two bytes.
Public methodWrite(UInt32)Writes a four-byte unsigned integer to the current stream and advances the stream position by four bytes.
Public methodWrite(UInt64)Writes an eight-byte unsigned integer to the current stream and advances the stream position by eight bytes.
Public methodWrite(Byte[], Int32, Int32)Writes a region of a byte array to the current stream.
Public methodWrite(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 methodWrite7BitEncodedIntWrites a 32-bit integer in a compressed format.
Top

  NameDescription
Public fieldStatic memberNullSpecifies a BinaryWriter with no backing store.
Protected fieldOutStreamHolds the underlying stream.
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.

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

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