Int32.CompareTo Method (Object)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Compares this instance to a specified object and returns an indication of their relative values.

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

public int CompareTo(
	object value
)

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

Any instance of Int32, regardless of its value, is considered greater than null.

value must be null or an instance of Int32; 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: