This documentation is archived and is not being maintained.

UInt64::CompareTo Method (Object)

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

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

public:
virtual int CompareTo(
	Object^ value
) sealed

Parameters

value
Type: System::Object
An object to compare, or nullptr.

Return Value

Type: System::Int32
A signed number indicating the relative values of this instance and value.

Return Value

Description

Less than zero

This instance is less than value.

Zero

This instance is equal to value.

Greater than zero

This instance is greater than value.

-or-

value is nullptr.

Implements

IComparable::CompareTo(Object)

ExceptionCondition
ArgumentException

value is not a UInt64.

Any instance of UInt64, regardless of its value, is considered greater than nullptr.

value must be nullptr or an instance of UInt64; otherwise, an exception is thrown.

The following code example demonstrates the CompareTo method.


   public ref class Temperature: public IComparable
   {
   public:
      /// <summary>
      /// IComparable.CompareTo implementation.
      /// </summary>
      virtual int CompareTo( Object^ obj )
      {
      if ( (Temperature^)( obj ) )
      {
         Temperature^ temp = (Temperature^)( obj );

            return m_value.CompareTo( temp->m_value );
         }

         throw gcnew ArgumentException( "object is not a Temperature" );
      }

   protected:
      // The value holder
      UInt64 m_value;

   public:
      property UInt64 Value 
      {
         UInt64 get()
         {
            return m_value;
         }
         void set( UInt64 value )
         {
            m_value = value;
         }
      }
   };
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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: