UInt32.CompareTo Method (UInt32)

Compares this instance to a specified 32-bit unsigned integer and returns an indication of their relative values.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

abstract CompareTo : 
        value:uint32 -> int  
override CompareTo : 
        value:uint32 -> int

Parameters

value
Type: System.UInt32

An unsigned integer to compare.

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.

Implements

IComparable(T).CompareTo(T)

This method implements the System.IComparable(T) interface and performs slightly better than the UInt32.CompareTo method because it does not have to convert the value parameter to an object.

Depending on your programming language, it might be possible to code a CompareTo method where the parameter type has fewer bits (is narrower) than the instance type. This is possible because some programming languages perform an implicit widening conversion that represents the parameter as a type with as many bits as the instance.

For example, suppose the instance type is Int32 and the parameter type is Byte. The Microsoft C# compiler generates instructions to represent the value of the parameter as an Int32 object, then generates a Int32.CompareTo method that compares the values of the Int32 instance and the Int32 parameter representation.

Consult your programming language's documentation to determine whether its compiler performs implicit widening conversions on numeric types.

The following code example demonstrates generic and nongeneric versions of the CompareTo method for several value and reference types.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft