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

UInt16.CompareTo Method (UInt16)

 

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

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

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

Parameters

value
Type: System.UInt16

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.

This method implements the System.IComparable<'T> interface and performs slightly better than the UInt16.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 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.

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft