Compares two strings with CultureInfo specific information.
[Visual Basic] 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, _ ByVal culture As CultureInfo _ ) As Integer [C#] public static int Compare( string strA, int indexA, string strB, int indexB, int length, bool ignoreCase, CultureInfo culture ); [C++] public: static int Compare( String* strA, int indexA, String* strB, int indexB, int length, bool ignoreCase, CultureInfo* culture ); [JScript] public static function Compare( strA : String, indexA : int, strB : String, indexB : int, length : int, ignoreCase : Boolean, culture : CultureInfo ) : int;
Value Type | Condition |
---|---|
A negative integer | If region A is less than region B. |
0 | If the two regions or length are equal. |
A positive integer | If region A is greater than region B. |
true | If the comparison is case-insensitive. |
Exception Type | Condition |
---|---|
ArgumentNullException | If either string is null. |
ArgumentOutOfRangeException | If the starting position of either string is out of range. |
ArgumentOutOfRangeException | If the length is negative. |
The Compare method does a locale sensitive comparison of two strings and returns a integer representation of their relationship with the specific culture information from CultureInfo, but also returns a Boolean about the strings case-sensitivity.
One string may be "less than" or "greater than" another string depending upon the rules of the national language under which the comparison is made. To compare strings without regard to national languages, see CompareOrdinal and CurrentCulture.
The region of the first string of the specified length, beginning at the position of the index for the first string, is compared with the region of the second string of specified length beginning at the position of the index for the second string. The locale is set by the information provided by CultureInfo.
The length parameter must be non-negative. If length equals zero (length = 0), then zero is returned.
String Class | String Members | System Namespace | String.Compare Overload List