DateTimeOffset.LessThan(DateTimeOffset, DateTimeOffset) Operator

Definition

Determines whether one specified DateTimeOffset object is less than a second specified DateTimeOffset object.

public:
 static bool operator <(DateTimeOffset left, DateTimeOffset right);
public static bool operator < (DateTimeOffset left, DateTimeOffset right);
static member ( < ) : DateTimeOffset * DateTimeOffset -> bool
Public Shared Operator < (left As DateTimeOffset, right As DateTimeOffset) As Boolean

Parameters

left
DateTimeOffset

The first object to compare.

right
DateTimeOffset

The second object to compare.

Returns

true if the UtcDateTime value of left is earlier than the UtcDateTime value of right; otherwise, false.

Remarks

The LessThan method defines the operation of the less than operator for DateTimeOffset objects. It enables code such as the following:

DateTimeOffset date1 = new DateTimeOffset(2007, 6, 3, 14, 45, 0, 
             new TimeSpan(-7, 0, 0));
DateTimeOffset date2 = new DateTimeOffset(2007, 6, 3, 15, 45, 0,
             new TimeSpan(-6, 0, 0));
DateTimeOffset date3 = new DateTimeOffset(date1.DateTime, 
             new TimeSpan(-8, 0, 0));
Console.WriteLine(date1 < date2);        // Displays False
Console.WriteLine(date1 < date3);        // Displays True 
Dim date1 As New DateTimeOffset(#6/3/2007 2:45PM#, _
             New TimeSpan(-7, 0, 0))
Dim date2 As New DateTimeOffset(#6/3/2007 3:45PM#, _
             New TimeSpan(-6, 0, 0))
Dim date3 As New DateTimeOffset(date1.DateTime, _
             New TimeSpan(-8, 0, 0))
Console.WriteLine(date1 < date2)        ' Displays False
Console.WriteLine(date1 < date3)        ' Displays True

Before evaluating the left and right operands, the operator converts both operands to Coordinated Universal Time (UTC). The operation is equivalent to the following:

return left.UtcDateTime < right.UtcDateTime;
Return left.UtcDateTime < right.UtcDateTime

Languages that do not support custom operators can call the Compare method instead. In addition, some languages can also call the LessThan method directly, as the following example shows.

Dim date1 As New DateTimeOffset(#6/3/2007 2:45PM#, _
             New TimeSpan(-7, 0, 0))
Dim date2 As New DateTimeOffset(#6/3/2007 3:45PM#, _
             New TimeSpan(-6, 0, 0))
Dim date3 As New DateTimeOffset(date1.DateTime, _
             New TimeSpan(-8, 0, 0))
Console.WriteLine(DateTimeOffset.op_LessThan(date1, date2))  ' Displays False
Console.WriteLine(DateTimeOffset.op_LessThan(date1, date3))  ' Displays True

The equivalent method for this operator is DateTimeOffset.Compare(DateTimeOffset, DateTimeOffset)

Applies to