Int32::CompareTo Method (Int32)
Compares this instance to a specified 32-bit signed integer and returns an indication of their relative values.
Assembly: mscorlib (in mscorlib.dll)
- Type: System::Int32
An integer to compare.
Return ValueType: System::Int32
A signed number indicating the relative values of this instance and value.
Less than zero
This instance is less than value.
This instance is equal to value.
Greater than zero
This instance is greater than value.
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, 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 the method. In addition to displaying the value returned by the method for four different comparisons, it converts the return value to a member of the custom Comparison enumeration, whose value it also displays.
.NET FrameworkSupported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
Portable Class LibrarySupported in: Portable Class Library
.NET for Windows Store appsSupported in: Windows 8
.NET for Windows Phone appsSupported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1
Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.