String.CompareTo Method (Object)
Assembly: mscorlib (in mscorlib.dll)
Return ValueType: System.Int32
A 32-bit signed integer that indicates whether this instance precedes, follows, or appears in the same position in the sort order as 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.
value must be a String object.
The CompareTo method was designed primarily for use in sorting or alphabetizing operations. It should not be used when the primary purpose of the method call is to determine whether two strings are equivalent. To determine whether two strings are equivalent, call the Equals method.
This method performs a word (case-sensitive and culture-sensitive) comparison using the current culture. For more information about word, string, and ordinal sorts, see System.Globalization.CompareOptions.
For more information about the behavior of this method, see the Remarks section of the String.Compare(String, String) method.
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