Information
Switch
Switch
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 (Object^)

.NET Framework (current version)
 

Compares this instance to a specified object and returns an integer that indicates whether this instance is shorter than, equal to, or longer than the specified object.

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

C#
C++
F#
VB
Copy 
public:
virtual int CompareTo(
	Object^ value
) sealed

Parameters

value
Type: System::Object^

An object to compare, or null.

Return Value

Type: System::Int32

One of the following values.

Value

Description

-1

This instance is shorter than value.

0

This instance is equal to value.

1

This instance is longer than value.

-or-

value is null.

Implements

IComparable::CompareTo(Object^)

Exception Condition
ArgumentException

value is not a TimeSpan.

Any instance of TimeSpan, regardless of its value, is considered greater than null.

The value parameter must be an instance of TimeSpan or null; otherwise, an exception is thrown.

The following example compares several TimeSpan structures and other objects to a reference TimeSpan structure using the CompareTo method.

C#
C++
VB
Copy 
// Example of the TimeSpan::CompareTo( Object* ) and 
// TimeSpan::Equals( Object* ) methods.
using namespace System;

// Compare the TimeSpan to the Object parameters, 
// and display the Object parameters with the results.
void CompTimeSpanToObject( TimeSpan Left, Object^ Right, String^ RightText )
{
   Console::WriteLine( "{0,-33}{1}", String::Concat( "Object: ", RightText ), Right );
   Console::WriteLine( "{0,-33}{1}", "Left.Equals( Object )", Left.Equals( Right ) );
   Console::Write( "{0,-33}", "Left.CompareTo( Object )" );

   // Catch the exception if CompareTo( ) throws one.
   try
   {
      Console::WriteLine( "{0}\n", Left.CompareTo( Right ) );
   }
   catch ( Exception^ ex ) 
   {
      Console::WriteLine( "Error: {0}\n", ex->Message );
   }

}

int main()
{
   TimeSpan Left = TimeSpan(0,5,0);
   Console::WriteLine( "This example of the TimeSpan::Equals( Object* ) "
   "and \nTimeSpan::CompareTo( Object* ) methods generates "
   "the \nfollowing output by creating several different "
   "TimeSpan \nobjects and comparing them with a "
   "5-minute TimeSpan.\n" );
   Console::WriteLine( "{0,-33}{1}\n", "Left: TimeSpan( 0, 5, 0 )", Left );

   // Create objects to compare with a 5-minute TimeSpan.
   CompTimeSpanToObject( Left, TimeSpan(0,0,300), "TimeSpan( 0, 0, 300 )" );
   CompTimeSpanToObject( Left, TimeSpan(0,5,1), "TimeSpan( 0, 5, 1 )" );
   CompTimeSpanToObject( Left, TimeSpan(0,5,-1), "TimeSpan( 0, 5, -1 )" );
   CompTimeSpanToObject( Left, TimeSpan(3000000000), "TimeSpan( 3000000000 )" );
   CompTimeSpanToObject( Left, 3000000000L, "__int64 3000000000L" );
   CompTimeSpanToObject( Left, "00:05:00", "String \"00:05:00\"" );
}

/*
This example of the TimeSpan::Equals( Object* ) and
TimeSpan::CompareTo( Object* ) methods generates the
following output by creating several different TimeSpan
objects and comparing them with a 5-minute TimeSpan.

Left: TimeSpan( 0, 5, 0 )        00:05:00

Object: TimeSpan( 0, 0, 300 )    00:05:00
Left.Equals( Object )            True
Left.CompareTo( Object )         0

Object: TimeSpan( 0, 5, 1 )      00:05:01
Left.Equals( Object )            False
Left.CompareTo( Object )         -1

Object: TimeSpan( 0, 5, -1 )     00:04:59
Left.Equals( Object )            False
Left.CompareTo( Object )         1

Object: TimeSpan( 3000000000 )   00:05:00
Left.Equals( Object )            True
Left.CompareTo( Object )         0

Object: __int64 3000000000L      3000000000
Left.Equals( Object )            False
Left.CompareTo( Object )         Error: Object must be of type TimeSpan.

Object: String "00:05:00"        00:05:00
Left.Equals( Object )            False
Left.CompareTo( Object )         Error: Object must be of type TimeSpan.
*/

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: