.NET Framework Class Library
DateTime..::.ToBinary Method

Serializes the current DateTime object to a 64-bit binary value that subsequently can be used to recreate the DateTime object.

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

Visual Basic (Declaration)
Public Function ToBinary As Long
Visual Basic (Usage)
Dim instance As DateTime
Dim returnValue As Long

returnValue = instance.ToBinary()
C#
public long ToBinary()
Visual C++
public:
long long ToBinary()
JScript
public function ToBinary() : long

Return Value

Type: System..::.Int64
A 64-bit signed integer that encodes the Kind and Ticks properties.
Remarks

Use the ToBinary method to convert the value of the current DateTime object to a binary value. Subsequently, use the binary value and the FromBinary method to recreate the original DateTime object.

Local Time Adjustment

A local time, which is a Coordinated Universal Time adjusted to the local time zone, is represented by a DateTime structure whose Kind property has the value Local. If a local DateTime object is serialized in one time zone by the ToBinary method and deserialized in a different time zone by the FromBinary method, the local time represented by the resulting DateTime object is automatically adjusted to the second time zone.

For example, consider a DateTime object that represents a local time of 3 P.M. An application executing in a western time zone uses the ToBinary method to convert that DateTime object to a binary value, then another application executing in a time zone three hours east of the original one uses the FromBinary method to convert the binary value to a new DateTime object. The value of the new DateTime object is 6 P.M., which represents the same point in time as the original 3 P.M. value, but is adjusted to local time in the eastern time zone.

Version Considerations

Starting with the .NET Framework version 2.0, a DateTime structure consists of a private Kind field, which indicates whether the specified time value is based on local time, Coordinated Universal Time (UTC), or neither, and a private Ticks field, which contains the number of 100-nanosecond ticks that specify a date and time. The Ticks field can be accessed with the Ticks property and the Kind field can be accessed with the Kind property.

Prior to the .NET Framework 2.0, if you serialized a DateTime object manually instead of using a serialization interface such as System.Runtime.Serialization..::.ISerializable, you only needed to serialize the Ticks data in the DateTime structure. Starting with version 2.0, you must also serialize the Kind data.

Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Tags :


Page view tracker