XmlWriter.WriteBinHex(Byte[], Int32, Int32) Method

Definition

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Source:

XmlWriter.cs

When overridden in a derived class, encodes the specified binary bytes as BinHex and writes out the resulting text.

public:
 virtual void WriteBinHex(cli::array <System::Byte> ^ buffer, int index, int count);

public virtual void WriteBinHex (byte[] buffer, int index, int count);

abstract member WriteBinHex : byte[] * int * int -> unit
override this.WriteBinHex : byte[] * int * int -> unit

Public Overridable Sub WriteBinHex (buffer As Byte(), index As Integer, count As Integer)

Parameters

buffer

Byte[]

Byte array to encode.

index

Int32

The position in the buffer indicating the start of the bytes to write.

count

Int32

The number of bytes to write.

Exceptions

ArgumentNullException

buffer is null.

InvalidOperationException

The writer is closed or in error state. -or-

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message "An asynchronous operation is already in progress."

ArgumentOutOfRangeException

index or count is less than zero.

-or-

The buffer length minus index is less than count.

Examples

The following example uses the WriteBinHex method to write BinHex data. The BinHex data is embedded within an <image> element.

public static void BinHexEncodeImageFile() {

  int bufferSize = 1000;
  byte[] buffer = new byte[bufferSize];
  int readBytes = 0;
    
  using (XmlWriter writer = XmlWriter.Create("output.xml")) {
       FileStream inputFile = new FileStream(@"C:\artFiles\sunset.jpg", FileMode.OpenOrCreate,
                                                                    FileAccess.Read, FileShare.Read);
       writer.WriteStartDocument();
       writer.WriteStartElement("image");
       BinaryReader br = new BinaryReader(inputFile);
       Console.WriteLine("\r\nWriting BinHex data...");

       do {
          readBytes = br.Read(buffer, 0, bufferSize);
          writer.WriteBinHex(buffer, 0, readBytes);
       } while (bufferSize <= readBytes);
       br.Close();

    writer.WriteEndElement();// </image>
    writer.WriteEndDocument();
  }
}

Public Shared Sub BinHexEncodeImageFile() 
    
    Dim bufferSize As Integer = 1000
    Dim buffer(bufferSize) As Byte
    Dim readBytes As Integer = 0
    
    Using writer As XmlWriter = XmlWriter.Create("output.xml")

            Dim inputFile As New FileStream("C:\artFiles\sunset.jpg", FileMode.OpenOrCreate, FileAccess.Read, FileShare.Read)
            writer.WriteStartDocument()
            writer.WriteStartElement("image")
            Dim br As New BinaryReader(inputFile)
            Console.WriteLine(vbCr + vbLf + "Writing BinHex data...")
            
            Do
                readBytes = br.Read(buffer, 0, bufferSize)
                writer.WriteBinHex(buffer, 0, readBytes)
            Loop While bufferSize <= readBytes
            br.Close()

        writer.WriteEndElement() ' </image>
        writer.WriteEndDocument()

    End Using
 
End Sub

Remarks

For the asynchronous version of this method, see WriteBinHexAsync.