Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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

Implements

IComparable.CompareTo(Object)
ExceptionCondition
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.

	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 uint m_value;

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

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.