StringCompare Method (String, Int32, String, Int32, Int32, Boolean) |
Compares substrings of two specified
String objects, ignoring or honoring their case, and returns an integer that indicates their relative position in the sort order.
Namespace: SystemAssembly: mscorlib (in mscorlib.dll) Version: 4.0.0.0
Syntax public static int Compare(
string strA,
int indexA,
string strB,
int indexB,
int length,
bool ignoreCase
)
Parameters
- strA
- Type: SystemString
The first string to use in the comparison. - indexA
- Type: SystemInt32
The position of the substring within strA. - strB
- Type: SystemString
The second string to use in the comparison. - indexB
- Type: SystemInt32
The position of the substring within strB. - length
- Type: SystemInt32
The maximum number of characters in the substrings to compare. - ignoreCase
- Type: SystemBoolean
true to ignore case during the comparison; otherwise, false.
Return Value
Type:
Int32A 32-bit signed integer that indicates the lexical relationship between the two comparands.ValueCondition 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.
Exceptions Exception | Condition |
---|
ArgumentOutOfRangeException | indexA is greater than strA.Length.-or- indexB is greater than strB.Length.-or- indexA, indexB, or length is negative. -or-Either indexA or indexB is null, and length is greater than zero. |
See Also