Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IBinarySerialize.Write Method

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

Namespace: Microsoft.SqlServer.Server
Assembly: System.Data (in system.data.dll)

void Write (
	BinaryWriter w
)
void Write (
	BinaryWriter w
)
function Write (
	w : BinaryWriter
)
Not applicable.

Parameters

w

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

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

The following example shows the implementation of the Writemethod 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
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);
}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.