DateTimeOffset.CompareTo Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Compares the current DateTimeOffset object to a specified DateTimeOffset object and indicates whether the current object is earlier than, the same as, or later than the second DateTimeOffset object.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- other
- Type: System.DateTimeOffset
An object to compare with the current DateTimeOffset object.
Return Value
Type: System.Int32A signed integer that indicates the relationship between the current DateTimeOffset object and other, as the following table shows.
Return value | Description |
|---|---|
Less than zero | The current DateTimeOffset object is earlier than other. |
Zero | The current DateTimeOffset object is the same as other. |
Greater than zero. | The current DateTimeOffset object is later than other. |
Implements
IComparable(Of T).CompareTo(T)This method compares DateTimeOffset objects by comparing their UtcDateTime values; that is, it determines whether the two objects represent a single point in time, and indicates whether the current object is earlier than, later than, or the same as the other parameter.
The following example illustrates calls to the CompareTo method to compare DateTimeOffset objects.
Module Example Private Enum TimeComparison As Integer Earlier = -1 Same = 0 Later = 1 End Enum Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock) Dim firstTime As New DateTimeOffset(#9/1/2007 6:45:00 AM#, _ New TimeSpan(-7, 0, 0)) Dim secondTime As DateTimeOffset = firstTime outputBlock.Text += String.Format("Comparing {0} and {1}: {2}", _ firstTime, secondTime, _ CType(firstTime.CompareTo(secondTime), _ TimeComparison)) + vbCrLf secondTime = New DateTimeOffset(#9/1/2007 6:45:00 AM#, _ New TimeSpan(-6, 0, 0)) outputBlock.Text += String.Format("Comparing {0} and {1}: {2}", _ firstTime, secondTime, _ CType(firstTime.CompareTo(secondTime), _ TimeComparison)) + vbCrLf secondTime = New DateTimeOffset(#9/1/2007 8:45:00 AM#, _ New TimeSpan(-5, 0, 0)) outputBlock.Text += String.Format("Comparing {0} and {1}: {2}", _ firstTime, secondTime, _ CType(firstTime.CompareTo(secondTime), _ TimeComparison)) + vbCrLf ' The example displays the following output: ' Comparing 9/1/2007 6:45:00 AM -07:00 and 9/1/2007 6:45:00 AM -07:00: Same ' Comparing 9/1/2007 6:45:00 AM -07:00 and 9/1/2007 6:45:00 AM -06:00: Later ' Comparing 9/1/2007 6:45:00 AM -07:00 and 9/1/2007 8:45:00 AM -05:00: Same End Sub End Module