This documentation is archived and is not being maintained.
TimeSpan::CompareTo Method (Object)
Visual Studio 2010
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.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System::Object
An object to compare, or nullptr.
Return Value
Type: System::Int32One 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 nullptr. |
Implements
IComparable::CompareTo(Object)| Exception | Condition |
|---|---|
| ArgumentException | value is not a TimeSpan. |
The following example compares several TimeSpan structures and other objects to a reference TimeSpan structure using the CompareTo method.
// 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. */
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: