C# Binary Writer - c# - c# tutorial - c# net



What is C# Binary Writer ?

  • C# BinaryWriter class is used to write binary information into stream.
  • It is found in System.IO namespace.
  • It also supports writing string in specific encoding.
  • BinaryWriter creates binary files. A binary file uses a specific data layout for its bytes.
  • The BinaryWriter type is ideal.
  • It provides a stream-based mechanism for imperatively writing data to a file location on the disk.
 C# BinaryWriter

Syntax:

[SerializableAttribute]
[ComVisibleAttribute(true)]
public class BinaryWriter : IDisposable

Constructors:

Name Description
BinaryWriter() Initializes a new instance of the BinaryWriter class that writes to a stream.
BinaryWriter(Stream) Initializes a new instance of the BinaryWriter class based on the specified stream and using UTF-8 encoding.
BinaryWriter(Stream, Encoding) Initializes a new instance of the BinaryWriter class based on the specified stream and character encoding.
BinaryWriter(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.

Properties:

Name Description
BaseStream Gets the underlying stream of the BinaryWriter.

Methods:

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

C# BinaryWriter Example:

  • Let's see the simple example of BinaryWriter class which writes data into data file.
using System;  
using System.IO;  
namespace BinaryWriterExample  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = "e:\\binaryfile.dat";  
            using (BinaryWriter writer = new BinaryWriter(File.Open(fileName, FileMode.Create)))  
            {  
                writer.Write(2.5);  
                writer.Write("this is string data");  
                writer.Write(true);  
            }  
            Console.WriteLine("Data written successfully...");    
        }  
    }  
} 

C# examples - Output :

Data written successfully...

Related Searches to C# Binary Writer