Int16.CompareTo Method (Object)

 

Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the object.

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 an Int16.

An Int16, regardless of its value, is considered greater than a null reference.

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

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