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)
Parameters
- value
- Type: System::Object
An object to compare this instance to, or nullptr.
Return Value
Type: System::Int32A signed number indicating the position of this instance in the sort order in relation to the value parameter.
Return Value | Description |
|---|---|
Less than zero | This instance precedes value. |
Zero | This instance has the same position in the sort order as value. |
Greater than zero | This instance follows value. -or- value is nullptr. |
Implements
IComparable::CompareTo(Object)| Exception | Condition |
|---|---|
| ArgumentException | value is not a Char object. |
The CompareTo method implements the IComparable interface.
The value parameter must be nullptr 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 nullptr.
The following code example demonstrates CompareTo.
using namespace System; int main() { char chA = 'A'; char chB = 'B'; Console::WriteLine( chA.CompareTo( 'A' ) ); // Output: "0" (meaning they're equal) Console::WriteLine( 'b'.CompareTo( chB ) ); // Output: "32" (meaning 'b' is greater than 'B' by 32) Console::WriteLine( chA.CompareTo( chB ) ); // Output: "-1" (meaning 'A' is less than 'B' by 1) }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.