IBinarySerialize.Write(BinaryWriter) Method

Definition

Namespace:

Microsoft.Data.SqlClient.Server

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v4.1.0

Converts a user-defined type (UDT) or user-defined aggregate into its binary format so that it may be persisted.

public:
 void Write(System::IO::BinaryWriter ^ w);

public void Write (System.IO.BinaryWriter w);

abstract member Write : System.IO.BinaryWriter -> unit

Public Sub Write (w As BinaryWriter)

Parameters

w

BinaryWriter

The BinaryWriter stream to which the UDT or user-defined aggregate is serialized.

Examples

The following example shows the implementation of the Write method of a UDT, which uses a BinaryWriter to serialize the UDT in the user-defined binary format. The purpose of the null character padding is to ensure that the string value is completely separated from the double value, so that one UDT is compared to another in Transact-SQL code, string bytes are compared to string bytes and double bytes are compared to double bytes.

// The binary layout is as follows:
//    Bytes 0 - 19: string text, padded to the right with null characters
//    Bytes 20+: Double value

// using Microsoft.SqlServer.Server;
public void Write(System.IO.BinaryWriter w)
{
    int maxStringSize = 20;
    string stringValue = "The value of PI: ";
    string paddedString;
    double value = 3.14159;

    // Pad the string from the right with null characters.
    paddedString = stringValue.PadRight(maxStringSize, '\0');

    // Write the string value one byte at a time.
    for (int i = 0; i < paddedString.Length; i++)
    {
        w.Write(paddedString[i]);
    }

    // Write the double value.
    w.Write(value);
}

Remarks

Write sufficient information to the binary stream to allow the Read method to reconstitute your UDT or user-defined aggregate.