String.CompareOrdinal Method (String, Int32, String, Int32, Int32)
Compares substrings of two specified String objects by evaluating the numeric values of the corresponding Char objects in each substring.
Assembly: mscorlib (in mscorlib.dll)
Public Shared Function CompareOrdinal ( strA As String, indexA As Integer, strB As String, indexB As Integer, length As Integer ) As Integer
Parameters
- strA
-
Type:
System.String
The first string to use in the comparison.
- indexA
-
Type:
System.Int32
The starting index of the substring in strA.
- strB
-
Type:
System.String
The second string to use in the comparison.
- indexB
-
Type:
System.Int32
The starting index of the substring in strB.
- length
-
Type:
System.Int32
The maximum number of characters in the substrings to compare.
Return Value
Type: System.Int32A 32-bit signed integer that indicates the lexical relationship between the two comparands.
Value | 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 | Condition |
|---|---|
| ArgumentOutOfRangeException |
The indexA, indexB, and length parameters must be nonnegative.
The number of characters compared is the lesser of the length of strA less indexA, the length of strB less indexB, and length.
This method performs a case-sensitive comparison using ordinal sort rules. For more information about word, string, and ordinal sorts, see System.Globalization.CompareOptions. To perform a case-insensitive comparison using ordinal sort rules, call theCompare(String, Int32, String, Int32, Int32, StringComparison)method with the comparisonType argument set toStringComparison.OrdinalIgnoreCase.
Because CompareOrdinal(String, String) is a static method, strA and strB can be null. If both values are null, the method returns 0 (zero), which indicates that strA and strB are equal. If only one of the values is null, the method considers the non-null value to be greater.
This following example demonstrates that CompareOrdinal and Compare use different sort orders.
Imports System Imports System.Globalization Class Test Public Shared Sub Main(args() As [String]) Dim strLow As [String] = "abc" Dim strCap As [String] = "ABC" Dim result As [String] = "equal to " Dim x As Integer = 0 Dim pos As Integer = 1 ' The Unicode codepoint for 'b' is greater than the codepoint for 'B'. x = [String].CompareOrdinal(strLow, pos, strCap, pos, 1) If x < 0 Then result = "less than" End If If x > 0 Then result = "greater than" End If ' In U.S. English culture, 'b' is linguistically less than 'B'. Console.WriteLine("CompareOrdinal(""{0}"".Chars({2}), ""{1}"".Chars({2})):", strLow, strCap, pos) Console.WriteLine(" '{0}' is {1} '{2}'", strLow.Chars(pos), result, strCap.Chars(pos)) x = [String].Compare(strLow, pos, strCap, pos, 1, False, New CultureInfo("en-US")) If x < 0 Then result = "less than" ElseIf x > 0 Then result = "greater than" End If Console.WriteLine("Compare(""{0}"".Chars({2}), ""{1}"".Chars({2})):", strLow, strCap, pos) Console.WriteLine(" '{0}' is {1} '{2}'", strLow.Chars(pos), result, strCap.Chars(pos)) End Sub 'Main End Class 'Test
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1