System Namespace   String Class

---

Compares substrings of two specified String objects.

[ VB ]
<Serializable>
Overloads Public Shared Function Compare ( _
   ByVal strA As String, _
   ByVal indexA As Integer, _
   ByVal strB As String, _
   ByVal indexB As Integer, _
   ByVal length As Integer _
) As Integer

[ C# ]
[ Serializable ]
public static int Compare (
   string strA,
   int indexA,
   string strB,
   int indexB,
   int length
);

[ C++ ]
[ Serializable ]
public: static int Compare (
   String* strA,
   int indexA,
   String* strB,
   int indexB,
   int length
);

[ JScript ]
public Serializable
static function Compare (
   strA : String,
   indexA : int,
   strB : String,
   indexB : int,
   length : int
) : int;

strA

The first String.

indexA

The position of the substring within strA.

strB

The second String.

indexB

The position of the substring within strB.

length

The maximum number of characters in the substrings to compare.

A 32-bit signed integer indicating the lexical relationship between the two comparands.

Value	Meaning
Less than zero	The substring in strA is less than the substring in strB.
Zero	The substrings are equal, or length is zero.
Greater than zero	The substring in strA is greater than the substring in strB.

Exception Type	Condition
ArgumentOutOfRangeException	The sum of indexA and length is greater than strA. Length. -or- The sum of indexB and length is greater than strB. Length. -or- indexA, indexB, or length is negative.

indexA and indexB are zero-based.

length cannot be negative. If length is zero, then zero is returned.

The number of characters compared is the lesser of the length of strA less indexA, the length of strB less indexB, and length.

By definition, any String, including the empty string, compares greater than a null reference ( Nothing in Visual Basic ); and two null references compare equal to each other.

This method performs a case-sensitive operation. The method uses the current culture to determine the ordering of individual characters. Uppercase letters evaluate greater than their lowercase equivalents. The two strings are compared on a character-by-character basis.

String Members   String.Compare Overload List   Int32   CompareOrdinal   CompareTo

Suggested Reading