Char.CompareTo Method (Object)
Compares this instance to a specified object and indicates whether this instance precedes, follows, or appears in the same position in the sort order as the specified Object.
Assembly: mscorlib (in mscorlib.dll)
An object to compare this instance to, or null.
Return ValueType: System.Int32
A signed number indicating the position of this instance in the sort order in relation to the value parameter.
Less than zero
This instance precedes value.
This instance has the same position in the sort order as value.
Greater than zero
This instance follows value.
value is null.
The IComparable interface.method implements the
The value parameter must be null or an instance of Char; otherwise, an exception is thrown.
The comparison performed by this method is based on the encoded values of this instance and value, not necessarily their lexicographical characteristics. Any instance of Char, regardless of its value, is considered greater than null.
The following code example demonstrates.
Imports System Module CompareToSample Sub Main() Dim chA As Char chA = "A"c Dim chB As Char chB = "B"c Console.WriteLine(chA.CompareTo("A"c)) ' Output: "0" (meaning they're equal) Console.WriteLine("b"c.CompareTo(chB)) ' Output: "32" (meaning 'b' is 32 greater than 'B') Console.WriteLine(chA.CompareTo(chB)) ' Output: "-1" (meaning 'A' is less than 'B' by 1) End Sub End Module
Available since 1.1
Available since 2.0
Windows Phone Silverlight
Available since 7.0