Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Char.CompareTo Method (Object)

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
)
public final int CompareTo (
	Object value
)
public final function CompareTo (
	value : Object
) : int

Parameters

value

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

Return Value

A signed number indicating the relative values of this instance and the value parameter.

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 a null reference (Nothing in Visual Basic).

Exception typeCondition

ArgumentException

value is not a Char object.

The CompareTo method implements the IComparable interface.

The value parameter must be a null reference (Nothing in Visual Basic) 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 a null reference (Nothing in Visual Basic).

The following code example demonstrates CompareTo.

using System;

public class CompareToSample {
	public static void 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)
	}
}

import System.* ;

public class CompareToSample
{
    public static void main(String[] args)
    {
        char chA = 'A';
        char chB = 'B';
        // Output: "0" (meaning they're equal)
        Console.WriteLine(((Char)chA).CompareTo((Char)('A'))); 
        // Output: "32" (meaning 'b' is greater than 'B' by 32)        
        Console.WriteLine(((Char)'b').CompareTo(chB)); 
        // Output: "-1" (meaning 'A' is less than 'B' by 1)
        Console.WriteLine(((Char)chA).CompareTo(chB));         
    } //main
} //CompareToSample

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.