This documentation is archived and is not being maintained.

TimeSpan.Compare Method

Compares two TimeSpan values and returns an integer that indicates their relationship.

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

'Declaration
Public Shared Function Compare ( _
	t1 As TimeSpan, _
	t2 As TimeSpan _
) As Integer
'Usage
Dim t1 As TimeSpan
Dim t2 As TimeSpan
Dim returnValue As Integer

returnValue = TimeSpan.Compare(t1, t2)
public static int Compare (
	TimeSpan t1, 
	TimeSpan t2
)
public static function Compare (
	t1 : TimeSpan, 
	t2 : TimeSpan
) : int
Not applicable.

Parameters

t1

A TimeSpan.

t2

A TimeSpan.

Return Value

Value

Condition

-1

t1 is less than t2

0

t1 is equal to t2

1

t1 is greater than t2

The following code example compares several TimeSpan objects to a reference TimeSpan using the Compare method.

' Example of the TimeSpan.Compare( TimeSpan, TimeSpan ) and 
' TimeSpan.Equals( TimeSpan, TimeSpan ) methods.
Imports System
Imports Microsoft.VisualBasic

Module TSCompareEqualsDemo
    
    Const dataFmt As String = "{0,-38}{1}"

    ' Compare TimeSpan parameters, and display them with the results.
    Sub CompareTimeSpans( Left as TimeSpan, Right as TimeSpan, _
        RightText as String )

        Console.WriteLine( )
        Console.WriteLine( dataFmt, "Right: " & RightText, Right )
        Console.WriteLine( dataFmt, "TimeSpan.Equals( Left, Right )", _
            TimeSpan.Equals( Left, Right ) )
        Console.WriteLine( dataFmt, _
            "TimeSpan.Compare( Left, Right )", _
            TimeSpan.Compare( Left, Right ) )
    End Sub

    Sub Main( )
        Dim Left as new TimeSpan( 2, 0, 0 )

        Console.WriteLine( _
            "This example of the TimeSpan.Equals( TimeSpan, " & _
            "TimeSpan ) and " & vbCrLf & "TimeSpan.Compare( " & _
            "TimeSpan, TimeSpan ) methods generates the " & vbCrLf & _
            "following output by creating several " & _
            "different TimeSpan " & vbCrLf & "objects and " & _
            "comparing them with a 2-hour TimeSpan." & vbCrLf )
        Console.WriteLine( dataFmt, "Left: TimeSpan( 2, 0, 0 )", Left )

        ' Create objects to compare with a 2-hour TimeSpan.
        CompareTimeSpans( Left, new TimeSpan( 0, 120, 0 ), _
            "TimeSpan( 0, 120, 0 )" )
        CompareTimeSpans( Left, new TimeSpan( 2, 0, 1 ), _
            "TimeSpan( 2, 0, 1 )" )
        CompareTimeSpans( Left, new TimeSpan( 2, 0, -1 ), _
            "TimeSpan( 2, 0, -1 )" )
        CompareTimeSpans( Left, new TimeSpan( 72000000000 ), _
            "TimeSpan( 72000000000 )" )
        CompareTimeSpans( Left, TimeSpan.FromDays( 1.0 / 12R ), _
            "TimeSpan.FromDays( 1 / 12 )" )
    End Sub 
End Module 

' This example of the TimeSpan.Equals( TimeSpan, TimeSpan ) and
' TimeSpan.Compare( TimeSpan, TimeSpan ) methods generates the
' following output by creating several different TimeSpan
' objects and comparing them with a 2-hour TimeSpan.
' 
' Left: TimeSpan( 2, 0, 0 )             02:00:00
' 
' Right: TimeSpan( 0, 120, 0 )          02:00:00
' TimeSpan.Equals( Left, Right )        True
' TimeSpan.Compare( Left, Right )       0
' 
' Right: TimeSpan( 2, 0, 1 )            02:00:01
' TimeSpan.Equals( Left, Right )        False
' TimeSpan.Compare( Left, Right )       -1
' 
' Right: TimeSpan( 2, 0, -1 )           01:59:59
' TimeSpan.Equals( Left, Right )        False
' TimeSpan.Compare( Left, Right )       1
' 
' Right: TimeSpan( 72000000000 )        02:00:00
' TimeSpan.Equals( Left, Right )        True
' TimeSpan.Compare( Left, Right )       0
' 
' Right: TimeSpan.FromDays( 1 / 12 )    02:00:00
' TimeSpan.Equals( Left, Right )        True
' TimeSpan.Compare( Left, Right )       0

// Example of the TimeSpan.Compare( TimeSpan, TimeSpan ) and 
// TimeSpan.Equals( TimeSpan, TimeSpan ) methods.
import System.*;

class TSCompareEqualsDemo
{
    private static String dataFmt = "{0,-38}{1}";

    // Compare TimeSpan parameters, and display them with the results.
    static void CompareTimeSpans(TimeSpan left, TimeSpan right, 
            String rightText)
    {
        Console.WriteLine();
        Console.WriteLine(dataFmt, "Right: " + rightText, right);
        Console.WriteLine(dataFmt, "TimeSpan.Equals( Left, Right )",
            ((System.Boolean)Convert.ToBoolean(TimeSpan.Equals
            (left, right))).toString());
        Console.WriteLine(dataFmt, "TimeSpan.Compare( Left, Right )",
            String.valueOf(TimeSpan.Compare(left, right)));
    } //CompareTimeSpans

    public static void main(String[] args)
    {
        TimeSpan left = new TimeSpan(2, 0, 0);

        Console.WriteLine(
            ("This example of the TimeSpan.Equals(TimeSpan,Time"
            + "Span) and \nTimeSpan.Compare( TimeSpan, TimeSpan ) " 
            + "methods generates the \nfollowing output by creating " 
            + "several different TimeSpan \nobjects and comparing " 
            + "them with a 2-hour TimeSpan.\n"));
        Console.WriteLine(dataFmt, "Left: TimeSpan( 2, 0, 0 )", left);

        // Create objects to compare with a 2-hour TimeSpan.
        CompareTimeSpans(left, new TimeSpan(0, 120, 0), 
            "TimeSpan( 0, 120, 0 )");
        CompareTimeSpans(left, new TimeSpan(2, 0, 1),
            "TimeSpan( 2, 0, 1 )");
        CompareTimeSpans(left, new TimeSpan(2, 0, -1), 
            "TimeSpan( 2, 0, -1 )");
        CompareTimeSpans(left, new TimeSpan(72000000000L),
            "TimeSpan( 72000000000 )");
        CompareTimeSpans(left, TimeSpan.FromDays((1.0 / 12.0)), 
            "TimeSpan.FromDays( 1 / 12 )");
    } //main
} //TSCompareEqualsDemo


/*
This example of the TimeSpan.Equals( TimeSpan, TimeSpan ) and
TimeSpan.Compare( TimeSpan, TimeSpan ) methods generates the
following output by creating several different TimeSpan
objects and comparing them with a 2-hour TimeSpan.

Left: TimeSpan( 2, 0, 0 )             02:00:00

right: TimeSpan( 0, 120, 0 )          02:00:00
TimeSpan.Equals( left, right )        True
TimeSpan.Compare( left, right )       0

right: TimeSpan( 2, 0, 1 )            02:00:01
TimeSpan.Equals( left, right )        False
TimeSpan.Compare( left, right )       -1

right: TimeSpan( 2, 0, -1 )           01:59:59
TimeSpan.Equals( left, right )        False
TimeSpan.Compare( left, right )       1

right: TimeSpan( 72000000000 )        02:00:00
TimeSpan.Equals( left, right )        True
TimeSpan.Compare( left, right )       0

right: TimeSpan.FromDays( 1 / 12 )    02:00:00
TimeSpan.Equals( left, right )        True
TimeSpan.Compare( left, right )       0
*/

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Show: