DateTime::CompareTo Method (DateTime)
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System::DateTime
The object to compare to the current instance.
Return Value
Type: System::Int32A signed number indicating the relative values of this instance and the value parameter.
Value | Description |
|---|---|
Less than zero | This instance is earlier than value. |
Zero | This instance is the same as value. |
Greater than zero | This instance is later than value. |
Implements
IComparable<T>::CompareTo(T)This method implements the System::IComparable<T> interface and performs slightly better than the DateTime::CompareTo(Object) method overload because it does not have to convert the value parameter to an object.
Before comparing DateTime objects, make sure that the objects represent times in the same time zone. You can do this by comparing the values of their Kind properties.
The following example instantiates three DateTime objects, one that represents today's date, another that represents the date one year previously, and a third that represents the date one year in the future. It then calls the CompareTo(DateTime) method and displays the result of the comparison.
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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
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.