Information
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.

DateTime.CompareTo Method (Object)

Compares this instance to a specified object and returns an indication of their relative values.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

public int CompareTo (
	Object value
)
public final int CompareTo (
	Object value
)
public final function CompareTo (
	value : Object
) : int

Parameters

value

A boxed DateTime object to compare, or a null reference (Nothing in Visual Basic).

Return Value

A signed number indicating the relative values of this instance and value.

Value

Description

Less than zero

This instance is less than value.

Zero

This instance is equal to value.

Greater than zero

This instance is greater than value, or value is a null reference (Nothing in Visual Basic).

Exception typeCondition

ArgumentException

value is not a DateTime.

Before comparing DateTime objects, insure that the objects represent times in the same time zone.

Any instance of DateTime, regardless of its value, is considered greater than a null reference (Nothing in Visual Basic).

The following code example demonstrates the CompareTo method.

System.DateTime theDay = 
          new System.DateTime(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 if (compareValue == 1) {
    System.Console.WriteLine("Value is null");
}
// compareValue > 0 && compareValue != 1
else { 
    System.Console.WriteLine("{0:d} has not come yet.", theDay);
}

System.DateTime theDay = new System.DateTime(System.DateTime.
    get_Today().get_Year(), 7, 28);
int compareValue;
try {
    compareValue = theDay.CompareTo(System.DateTime.get_Today());
}
catch (ArgumentException exp) {
    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 {
        if (compareValue == 1) {
            System.Console.WriteLine("Value is null");
        }
        // compareValue > 0 && compareValue != 1
        else {
            System.Console.WriteLine("{0:d} has not come yet.", 
                theDay);
        }
    } 
}

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft