The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
.NET Framework 4.5
Namespace: System
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. |
The following example demonstrates the CompareTo method.
System.DateTime theDay = new System.DateTime(System.DateTime.Today.Year, 7, 28); int compareValue; try { compareValue = theDay.CompareTo(DateTime.Today); } catch (ArgumentException) { 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 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
