BinaryWriter Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

System.Object
  System.IO.BinaryWriter

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

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public Class BinaryWriter _
    Implements IDisposable
[ComVisibleAttribute(true)]
public class BinaryWriter : IDisposable

The BinaryWriter type exposes the following members.

Constructors

  Name Description
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 BinaryWriter() Initializes a new instance of the BinaryWriter class that writes to a stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 BinaryWriter(Stream) Initializes a new instance of the BinaryWriter class based on the supplied stream and using UTF-8 as the encoding for strings.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 BinaryWriter(Stream, Encoding) Initializes a new instance of the BinaryWriter class based on the supplied stream and a specific character encoding.

Top

Properties

  Name Description
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360 BaseStream Gets the underlying stream of the BinaryWriter.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Close Closes the current BinaryWriter and the underlying stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Dispose() Releases the resources used by the current instance of the BinaryWriter class.
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Dispose(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 methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Flush Clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 GetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Seek Sets the position within the current stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 ToString Returns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Boolean) Writes a one-byte Boolean value to the current stream, with 0 representing false and 1 representing true.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Byte) Writes an unsigned byte to the current stream and advances the stream position by one byte.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(array<Byte[]) Writes a byte array to the underlying stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(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 Silverlight for Windows PhoneSupported by Xbox 360 Write(array<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 Silverlight for Windows PhoneSupported by Xbox 360 Write(Double) Writes an eight-byte floating-point value to the current stream and advances the stream position by eight bytes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Int16) Writes a two-byte signed integer to the current stream and advances the stream position by two bytes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Int32) Writes a four-byte signed integer to the current stream and advances the stream position by four bytes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Int64) Writes an eight-byte unsigned integer to the current stream and advances the stream position by eight bytes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(SByte) Writes a signed byte to the current stream and advances the stream position by one byte.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(Single) Writes a four-byte floating-point value to the current stream and advances the stream position by four bytes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(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 Silverlight for Windows PhoneSupported by Xbox 360 Write(UInt16) Writes a two-byte unsigned integer to the current stream and advances the stream position by two bytes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(UInt32) Writes a four-byte unsigned integer to the current stream and advances the stream position by four bytes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(UInt64) Writes an eight-byte unsigned integer to the current stream and advances the stream position by eight bytes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(array<Byte[], Int32, Int32) Writes a region of a byte array to the current stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Write(array<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 Silverlight for Windows PhoneSupported by Xbox 360 Write7BitEncodedInt Writes a 32-bit integer in a compressed format.

Top

Fields

  Name Description
Public fieldStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360 Null Specifies a BinaryWriter with no backing store.
Protected fieldSupported by Silverlight for Windows PhoneSupported by Xbox 360 OutStream Holds the underlying stream.

Top

Remarks

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

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

See Also

Reference