Export (0) Print
Expand All

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

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

Parameters

value
Type: System.Object
An object to compare, or Nothing.

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

Implements

IComparable.CompareTo(Object)

ExceptionCondition
ArgumentException

value is not a UInt32.

Any instance of UInt32, regardless of its value, is considered greater than Nothing.

The value parameter must be Nothing or an instance of UInt32; otherwise, an exception is thrown.

The following code example demonstrates the CompareTo method.


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

   ''' <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 UInteger
      Get
         Return m_value
      End Get
      Set(ByVal value As UInteger)
         Me.m_value = Value
      End Set
   End Property
End Class


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:
© 2014 Microsoft