String.CompareTo(String) Method

Definition

Compares two strings lexicographically.

[Android.Runtime.Register("compareTo", "(Ljava/lang/String;)I", "")]
public int CompareTo (string anotherString);
[<Android.Runtime.Register("compareTo", "(Ljava/lang/String;)I", "")>]
member this.CompareTo : string -> int

Parameters

anotherString
String

the String to be compared.

Returns

Int32

the value 0 if the argument string is equal to this string; a value less than 0 if this string is lexicographically less than the string argument; and a value greater than 0 if this string is lexicographically greater than the string argument.

Attributes

Exceptions

if string is null.

Remarks

Java documentation for java.lang.String.compareTo(java.lang.String).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to