CompareTo Method (Object)
Collapse the table of content
Expand the table of content

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

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

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

value must be Nothing or an instance of UInt64; 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 ULong

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


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2017 Microsoft