UInt16.CompareTo Method (Object)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
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.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- value
- Type: System.Object
An object to compare, or null.
Return Value
Type: System.Int32A 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 UInt16. |
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; } } }