DateTime.Compare Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Compares two instances of DateTime and returns an integer that indicates whether the first DateTime instance is earlier than, the same as, or later than the second DateTime instance.

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

Syntax

Public Shared Function Compare ( _
    t1 As DateTime, _
    t2 As DateTime _
) As Integer
public static int Compare(
    DateTime t1,
    DateTime t2
)

Parameters

Return Value

Type: System..::.Int32
A signed number indicating the relative values of t1 and t2.

Value Type

Condition

Less than zero

t1 is earlier than t2.

Zero

t1 is the same as t2.

Greater than zero

t1 is later than t2.

Remarks

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

Examples

The following example demonstrates the Compare method.

Dim date1 As Date = #08/01/2009 12:00AM#
Dim date2 As Date = #08/01/2009 12:00PM#
Dim result As Integer = DateTime.Compare(date1, date2)
Dim relationship As String

If result < 0 Then
   relationship = "is earlier than"
ElseIf result = 0 Then
   relationship = "is the same time as"         
Else
   relationship = "is later than"
End If

outputBlock.Text += String.Format("{0} {1} {2}", date1, relationship, date2) + Environment.NewLine
' The example displays the following output:
'    8/1/2009 12:00:00 AM is earlier than 8/1/2009 12:00:00 PM
DateTime date1 = new DateTime(2009, 8, 1, 0, 0, 0);
DateTime date2 = new DateTime(2009, 8, 1, 12, 0, 0);
int result = DateTime.Compare(date1, date2);
string relationship;

if (result < 0)
   relationship = "is earlier than";
else if (result == 0)
   relationship = "is the same time as";         
else
   relationship = "is later than";

outputBlock.Text += String.Format("{0} {1} {2}", date1, relationship, date2) + Environment.NewLine;
// The example displays the following output:
//    8/1/2009 12:00:00 AM is earlier than 8/1/2009 12:00:00 PM

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

DateTime Structure

System Namespace

CompareTo

Equals