DateTime::CompareTo Method (DateTime)
Assembly: mscorlib (in mscorlib.dll)
- Type: System::DateTime
The object to compare to the current instance.
Return ValueType: System::Int32
A signed number indicating the relative values of this instance and the value parameter.
Less than zero
This instance is earlier than value.
This instance is the same as value.
Greater than zero
This instance is later than value.
To determine the relationship of the current instance to value, the CompareTo method compares the Ticks property of the current instance and value but ignores their Kind property. 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.
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.
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 method and displays the result of the comparison.