DateTime::CompareTo Method (Object^)
Compares the value of this instance to a specified object that contains a specified DateTime value, and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified DateTime value.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
-
Type:
System::Object^
A boxed object to compare, or null.
Return Value
Type: System::Int32A signed number indicating the relative values of this instance and value.
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, or value is null. |
Implements
IComparable::CompareTo(Object^)| Exception | Condition |
|---|---|
| ArgumentException | value is not a DateTime. |
To determine the relationship of the current instance to value, theCompareTo 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.
Any instance of DateTime, regardless of its value, is considered greater than null.
The following example demonstrates the CompareTo method.
using namespace System; void main() { System::DateTime theDay(System::DateTime::Today.Year,7,28); int compareValue; try { compareValue = theDay.CompareTo( System::DateTime::Today ); } catch ( ArgumentException^ ) { System::Console::WriteLine( "Value is not a DateTime" ); return; } if ( compareValue < 0 ) { System::Console::WriteLine( "{0:d} is in the past.", theDay ); } else if ( compareValue == 0 ) { System::Console::WriteLine( "{0:d} is today!", theDay ); } else // compareValue > 0 { System::Console::WriteLine( "{0:d} has not come yet.", theDay ); } }
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0