Article
11/18/2011

UInt16.CompareTo Method (Object)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is greater than, equal to, or less than the value of the specified object.

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

Syntax

'Declaration
Public Function CompareTo ( _
    value As Object _
) As Integer

public int CompareTo(
    Object value
)

Parameters

value
Type: System.Object
An object to compare, or nulla null reference (Nothing in Visual Basic).

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 nulla null reference (Nothing in Visual Basic).

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 nulla null reference (Nothing in Visual Basic).

Implements

IComparable.CompareTo(Object)

Exceptions

Exception	Condition
ArgumentException	value is not a UInt16.

Remarks

Any instance of UInt16, regardless of its value, is considered greater than nulla null reference (Nothing in Visual Basic).

value must be nulla null reference (Nothing in Visual Basic) or an instance of UInt16; otherwise, an exception is thrown.

Examples

The following code example demonstrates the CompareTo method.

Public Class Temperature : Implements IComparable
   ' The value holder
   Protected m_value As UShort

   ''' <summary>
   ''' IComparable.CompareTo implementation.
   ''' </summary>
   Public Function CompareTo(ByVal obj As Object) As Integer _
          Implements IComparable.CompareTo

      If TypeOf (obj) Is Temperature Then
         Dim temp As Temperature = DirectCast(obj, Temperature)

         Return m_value.CompareTo(temp.m_value)
      End If

      Throw New ArgumentException("object is not a Temperature")
   End Function

   Public Property Value() As UShort
      Get
         Return m_value
      End Get
      Set(ByVal value As UShort)
         Me.m_value = Value
      End Set
   End Property
End Class

public class Temperature : IComparable
{
   /// <summary>
   /// IComparable.CompareTo implementation.
   /// </summary>
   public int CompareTo(object obj)
   {
      if (obj is Temperature)
      {
         Temperature temp = (Temperature)obj;

         return m_value.CompareTo(temp.m_value);
      }

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

   // The value holder
   protected ushort m_value;

   public ushort Value
   {
      get
      {
         return m_value;
      }
      set
      {
         m_value = value;
      }
   }
}

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Share via