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.

UInt32::CompareTo Method (Object^)

.NET Framework (current version)
 

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

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

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 null.

Implements

IComparable::CompareTo(Object^)

Exception Condition
ArgumentException

value is not a UInt32.

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

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

The following code example demonstrates the CompareTo method.

C#
C++
VB
Copy 
   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
      UInt32 m_value;

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

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