System Namespace   String Class

---

Compares substrings of two specified String objects, ignoring or honoring their case.

[ 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, _
   ByVal ignoreCase As Boolean _
) As Integer

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

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

[ JScript ]
public Serializable
static function Compare (
   strA : String,
   indexA : int,
   strB : String,
   indexB : int,
   length : int,
   ignoreCase : Boolean
) : 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.

ignoreCase

A Boolean indicating a case-sensitive or insensitive comparison. ( true indicates a case-insensitive comparison. )

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

Value Type	Condition
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	Either index is outside the series of characters to be compared. -or- length is negative.

indexA and indexB are zero-based. length cannot be negative.

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 uses the current culture to determine the ordering of individual characters. The two strings are compared on a character-by-character basis.

String Members   String.Compare Overload List   Int32   CompareOrdinal   CompareTo

Suggested Reading