Windows apps
Collapse the table of content
Expand the table of content

String.IComparable.CompareTo Method

.NET Framework (current version)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

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

private abstract CompareTo : 
        value:Object -> int  
private override CompareTo : 
        value:Object -> int


Type: System.Object

An object to compare with this instance, or a null reference (Nothing in Visual Basic).

Return Value

Type: System.Int32
A signed integer that indicates the relative order of this instance and value.

Return value


Less than zero

This instance precedes value in the sort order.


This instance occurs in the same position as value in the sort order.

Greater than zero

This instance follows value in the sort order.


value is a null reference (Nothing in Visual Basic).




value is not a String.

This member is an explicit interface implementation. It can be used only when the String instance is cast to an IComparable interface.

Portable Class Library

Supported in: Portable Class Library
© 2018 Microsoft