Windows apps
Collapse the table of content
Expand the table of content
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.

TimeSpan.CompareTo Method (TimeSpan)

Note: This method is new in the .NET Framework version 2.0.

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

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

'Declaration
Public Function CompareTo ( _
	value As TimeSpan _
) As Integer
'Usage
Dim instance As TimeSpan
Dim value As TimeSpan
Dim returnValue As Integer

returnValue = instance.CompareTo(value)
public final int CompareTo (
	TimeSpan value
)
public final function CompareTo (
	value : TimeSpan
) : int

Parameters

value

A TimeSpan object to compare to this instance.

Return Value

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

Value

Description

A negative integer

This instance is less than value.

Zero

This instance is equal to value.

A positive integer

This instance is greater than value.

This method implements the System.IComparable interface and performs slightly better than the TimeSpan.CompareTo method because it does not have to convert the value parameter to an object.

The following code example demonstrates generic and nongeneric versions of the CompareTo method for several value and reference types.

' This example demonstrates the generic and non-generic versions of the 
' CompareTo method for several base types.
' The non-generic version takes a parameter of type Object, while the generic
' version takes a type-specific parameter, such as Boolean, Int32, or Double.

Imports System

Class Sample
   Public Shared Sub Main()
      Dim nl As String = Environment.NewLine
      Dim msg As String = _
          "{0}The following is the result of using the generic and non-generic{0}" & _
          "versions of the CompareTo method for several base types:{0}"
      
      Dim now As DateTime = DateTime.Now
      ' Time span = 11 days, 22 hours, 33 minutes, 44 seconds
      Dim tsX As New TimeSpan(11, 22, 33, 44)
      ' Version = 1.2.333.4
      Dim versX As New Version("1.2.333.4")
      ' Guid = CA761232-ED42-11CE-BACD-00AA0057B223
      Dim guidX As New Guid("{CA761232-ED42-11CE-BACD-00AA0057B223}")
      
      Dim a1 As [Boolean] = True,    a2 As [Boolean] = True
      Dim b1 As [Byte] = 1,          b2 As [Byte] = 1
      Dim c1 As Int16 = -2,          c2 As Int16 = 2
      Dim d1 As Int32 = 3,           d2 As Int32 = 3
      Dim e1 As Int64 = 4,           e2 As Int64 = -4
      Dim f1 As [Decimal] = -5.5D,   f2 As [Decimal] = 5.5D
      Dim g1 As [Single] = 6.6F,     g2 As [Single] = 6.6F
      Dim h1 As [Double] = 7.7,      h2 As [Double] = -7.7
      Dim i1 As [Char] = "A"c,       i2 As [Char] = "A"c
      Dim j1 As String = "abc",      j2 As String = "abc"
      Dim k1 As DateTime = now,      k2 As DateTime = now
      Dim l1 As TimeSpan = tsX,      l2 As TimeSpan = tsX
      Dim m1 As Version = versX,     m2 As New Version("2.0")
      Dim n1 As Guid = guidX,        n2 As Guid = guidX
      
      ' The following types are not CLS-compliant.
      ' SByte, UInt16, UInt32, UInt64

      Console.WriteLine(msg, nl)
      Try
         ' The second and third Show method call parameters are automatically boxed because
         ' the second and third Show method declaration arguments expect type Object.

         Show("Boolean:  ", a1, a2, a1.CompareTo(a2), a1.CompareTo(CObj(a2)))
         Show("Byte:     ", b1, b2, b1.CompareTo(b2), b1.CompareTo(CObj(b2)))
         Show("Int16:    ", c1, c2, c1.CompareTo(c2), c1.CompareTo(CObj(c2)))
         Show("Int32:    ", d1, d2, d1.CompareTo(d2), d1.CompareTo(CObj(d2)))
         Show("Int64:    ", e1, e2, e1.CompareTo(e2), e1.CompareTo(CObj(e2)))
         Show("Decimal:  ", f1, f2, f1.CompareTo(f2), f1.CompareTo(CObj(f2)))
         Show("Single:   ", g1, g2, g1.CompareTo(g2), g1.CompareTo(CObj(g2)))
         Show("Double:   ", h1, h2, h1.CompareTo(h2), h1.CompareTo(CObj(h2)))
         Show("Char:     ", i1, i2, i1.CompareTo(i2), i1.CompareTo(CObj(i2)))
         Show("String:   ", j1, j2, j1.CompareTo(j2), j1.CompareTo(CObj(j2)))
         Show("DateTime: ", k1, k2, k1.CompareTo(k2), k1.CompareTo(CObj(k2)))
         Show("TimeSpan: ", l1, l2, l1.CompareTo(l2), l1.CompareTo(CObj(l2)))
         Show("Version:  ", m1, m2, m1.CompareTo(m2), m1.CompareTo(CObj(m2)))
         Show("Guid:     ", n1, n2, n1.CompareTo(n2), n1.CompareTo(CObj(n2)))
         '
         Console.WriteLine("{0}The following types are not CLS-compliant:", nl)
         Console.WriteLine("SByte, UInt16, UInt32, UInt64")

      Catch e As Exception
         Console.WriteLine(e)
      End Try
   End Sub 'Main
   
   Public Shared Sub Show(caption As String, var1 As [Object], var2 As [Object], _
                          resultGeneric As Integer, resultNonGeneric As Integer)
      Dim relation As String
      
      Console.Write(caption)
      If resultGeneric = resultNonGeneric Then
         If resultGeneric < 0 Then
            relation = "less than"
         ElseIf resultGeneric > 0 Then
            relation = "greater than"
         Else
            relation = "equal to"
         End If
         Console.WriteLine("{0} is {1} {2}", var1, relation, var2)
      
      ' The following condition will never occur because the generic and non-generic
      ' CompareTo methods are equivalent.

      Else
         Console.WriteLine("Generic CompareTo = {0}; non-generic CompareTo = {1}", _
                            resultGeneric, resultNonGeneric)
      End If
   End Sub 'Show
End Class 'Sample
'
'This example produces the following results:
'
'The following is the result of using the generic and non-generic versions of the
'CompareTo method for several base types:
'
'Boolean:  True is equal to True
'Byte:     1 is equal to 1
'Int16:    -2 is less than 2
'Int32:    3 is equal to 3
'Int64:    4 is greater than -4
'Decimal:  -5.5 is less than 5.5
'Single:   6.6 is equal to 6.6
'Double:   7.7 is greater than -7.7
'Char:     A is equal to A
'String:   abc is equal to abc
'DateTime: 12/1/2003 5:37:46 PM is equal to 12/1/2003 5:37:46 PM
'TimeSpan: 11.22:33:44 is equal to 11.22:33:44
'Version:  1.2.333.4 is less than 2.0
'Guid:     ca761232-ed42-11ce-bacd-00aa0057b223 is equal to ca761232-ed42-11ce-bacd-00
'aa0057b223
'
'The following types are not CLS-compliant:
'SByte, UInt16, UInt32, UInt64
'

// This example demonstrates the generic and non-generic versions of the 
// CompareTo method for several base types.
// The non-generic version takes a parameter of type Object, while the generic
// version takes a type-specific parameter, such as Boolean, Int32, or Double.

import System.*;

class Sample
{
    public static void main(String[] args)
    {
        String nl = Environment.get_NewLine();
        String msg = "{0}The following is the result of using the generic and"
            +" non-generic{0}versions of the CompareTo method for"
            +" several base types:{0}";

        DateTime now = DateTime.get_Now();

        // Time span = 11 days, 22 hours, 33 minutes, 44 seconds
        TimeSpan tsX = new TimeSpan(11, 22, 33, 44);

        // Version = 1.2.333.4
        Version versX = new Version("1.2.333.4");

        // Guid = CA761232-ED42-11CE-BACD-00AA0057B223
        Guid guidX = new Guid("{CA761232-ED42-11CE-BACD-00AA0057B223}");

        System.Boolean a1 = true,a2 = true;
        System.Byte b1 = (System.Byte)1,b2 =(System.Byte)1;
        Int16 c1 = (System.Int16)(-2),c2 = (System.Int16)2;
        Int32 d1 = (System.Int32)3,d2 = (System.Int32)3;
        Int64 e1 = (System.Int64)4,e2 = (System.Int64)(-4);
        Decimal f1 = new Decimal(-5.5),f2 = new Decimal(5.5);
        Single g1 = (System.Single)6.6,g2 = (System.Single)6.6;
        System.Double h1 = (System.Double)7.7,h2 = (System.Double)(-7.7);
        System.Char i1 = (System.Char)'A',i2 = (System.Char)'A';;
        String j1 = "abc", j2 = "abc";
        DateTime k1 = now, k2 = now;
        TimeSpan l1 = tsX, l2 = tsX;
        Version m1 = versX, m2 = new Version("2.0");
        Guid n1 = guidX, n2 = guidX;

        // The following types are not CLS-compliant.
        SByte w1 = (System.SByte)8,w2 = (System.SByte)8;
        UInt16 x1 = (System.UInt16)9,x2 = (System.UInt16)9;
        UInt32 y1 = (System.UInt32)10,y2 = (System.UInt32)10;
        UInt64 z1 = (System.UInt64)11,z2 = (System.UInt64)11;
        //
        Console.WriteLine(msg, nl);
        try {
            // The second and third Show method call parameters are
            // automatically boxed because the second and third Show method
            // declaration arguments expect type Object.
            Show("Boolean:  ", a1, a2, a1.CompareTo(a2),
                a1.CompareTo((Object)a2));
            Show("Byte:     ", b1, b2, b1.CompareTo(b2),
                b1.CompareTo((Object)b2));
            Show("Int16:    ", c1, c2, c1.CompareTo(c2), 
                c1.CompareTo((Object)c2));
            Show("Int32:    ", d1, d2, d1.CompareTo(d2),
                d1.CompareTo((Object)d2));
            Show("Int64:    ", e1, e2, e1.CompareTo(e2),
                e1.CompareTo(((Object)e2)));
            Show("Decimal:  ", f1, f2, f1.CompareTo(f2),
                f1.CompareTo((Object)f2));
            Show("Single:   ", g1, g2, g1.CompareTo(g2),
                g1.CompareTo((Object)g2));
            Show("Double:   ", h1, h2, h1.CompareTo(h2),
                h1.CompareTo((Object)h2));
            Show("Char:     ", i1, i2, i1.CompareTo(i2), 
                i1.CompareTo(((Object)i2)));
            Show("String:   ", j1, j2, j1.CompareTo(j2),
                j1.CompareTo((Object)j2));
            Show("DateTime: ", k1, k2, k1.CompareTo(k2),
                k1.CompareTo((Object)(k2)));
            Show("TimeSpan: ", l1, l2, l1.CompareTo(l2),
                l1.CompareTo((Object)l2));
            Show("Version:  ", m1, m2, m1.CompareTo(m2), 
                m1.CompareTo((Object)m2));
            Show("Guid:     ", n1, n2, n1.CompareTo(n2), 
                n1.CompareTo((Object)n2));
            //
            Console.WriteLine(
                "{0}The following types are not CLS-compliant:", nl);
            Show("SByte:    ", w1, w2, w1.CompareTo(w2),
                w1.CompareTo((Object)w2));
            Show("UInt16:   ", x1, x2, x1.CompareTo(x2), 
                x1.CompareTo((Object)x2));
            Show("UInt32:   ", y1, y2, y1.CompareTo(y2),
                y1.CompareTo((Object)y2));
            Show("UInt64:   ", z1, z2, z1.CompareTo(z2),
                z1.CompareTo((Object)z2));
        }
        catch (System.Exception e) {
            Console.WriteLine(e);
        }
    } //main

    public static void Show(String caption, Object var1, Object var2,
        int resultGeneric, int resultNonGeneric)
    {
        String relation;

        Console.Write(caption);
        if (resultGeneric == resultNonGeneric) {
            if (resultGeneric < 0) {
                relation = "less than";
            }
            else {
                if (resultGeneric > 0) {
                    relation = "greater than";
                }
                else {
                    relation = "equal to";
                }
            }
            Console.WriteLine("{0} is {1} {2}", var1, relation, var2);
        }
        // The following condition will never occur because the generic and 
        // non-generic CompareTo methods are equivalent.
        else {
            Console.WriteLine("Generic CompareTo = {0};"
                +" non-generic CompareTo = {1}",
                System.Convert.ToString(resultGeneric),
                System.Convert.ToString(resultNonGeneric));
        }
    } //Show
} //Sample
/*
This example produces the following results:

The following is the result of using the generic and non-generic versions of the
CompareTo method for several base types:

Boolean:  True is equal to True
Byte:     1 is equal to 1
Int16:    -2 is less than 2
Int32:    3 is equal to 3
Int64:    4 is greater than -4
Decimal:  -5.5 is less than 5.5
Single:   6.6 is equal to 6.6
Double:   7.7 is greater than -7.7
Char:     A is equal to A
String:   abc is equal to abc
DateTime: 12/1/2003 5:37:46 PM is equal to 12/1/2003 5:37:46 PM
TimeSpan: 11.22:33:44 is equal to 11.22:33:44
Version:  1.2.333.4 is less than 2.0
Guid:     ca761232-ed42-11ce-bacd-00aa0057b223 is equal to ca761232-ed42
-11ce-bacd-00aa0057b223

The following types are not CLS-compliant:
SByte:    8 is equal to 8
UInt16:   9 is equal to 9
UInt32:   10 is equal to 10
UInt64:   11 is equal to 11
*/

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

.NET Compact Framework

Supported in: 2.0

Community Additions

Show:
© 2017 Microsoft