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

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 Function CompareTo (
	value As Object
) As Integer

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 : Implements IComparable 
	' The value holder
	Protected m_value As ULong

	''' <summary>
	''' IComparable.CompareTo implementation.
	''' </summary>
	Public Function CompareTo(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 
			Me.m_value = value
		End Set
	End Property
End Class

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show:
© 2016 Microsoft