Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

UInt16.CompareTo Method (Object)

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)

public int CompareTo(
	Object value
)

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)

ExceptionCondition
ArgumentException

value is not a UInt16.

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

value must be null or an instance of UInt16; otherwise, an exception is thrown.

The following code example demonstrates the CompareTo method.


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;
      }
   }
}


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

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

Community Additions

ADD
Show:
© 2015 Microsoft