This documentation is archived and is not being maintained.
DateTime::CompareTo Method (Object)
Visual Studio 2010
Namespace:
System
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System::Object
A boxed object to compare, or nullptr.
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 nullptr. |
Implements
IComparable::CompareTo(Object)| Exception | Condition |
|---|---|
| ArgumentException | value is not a DateTime. |
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 ); } }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: