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

Exception Condition
ArgumentException

value is not a UInt64.

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

value must be null or an instance of UInt64; 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 ulong m_value;

	public ulong Value {
		get {
			return m_value;
		}
		set {
			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: