Export (0) Print
Expand All

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.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

[SecuritySafeCriticalAttribute]
public static int CompareOrdinal(
	string strA,
	int indexA,
	string strB,
	int indexB,
	int length
)

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.Int32
A 32-bit signed integer indicating 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.

ExceptionCondition
ArgumentOutOfRangeException

strA is not null and indexA is greater than strA. Length.

-or-

strB is not null and indexB is greater than strB. Length.

-or-

indexA, indexB, or length is negative.

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.

Because CompareOrdinal 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 code example demonstrates that CompareOrdinal and Compare use different sort orders.


using System;
using System.Globalization;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      String strLow = "abc";
      String strCap = "ABC";
      String result = "equal to ";
      int x = 0;
      int pos = 1;

      // The Unicode codepoint for 'b' is greater than the codepoint for 'B'.
      x = String.CompareOrdinal(strLow, pos, strCap, pos, 1);
      if (x < 0) result = "less than";
      if (x > 0) result = "greater than";
      outputBlock.Text += String.Format("CompareOrdinal(\"{0}\"[{2}], \"{1}\"[{2}]):", strLow, strCap, pos) + "\n";
      outputBlock.Text += String.Format("   '{0}' is {1} '{2}'", strLow[pos], result, strCap[pos]) + "\n";

      // In U.S. English culture, 'b' is linguistically less than 'B'.
      x = String.Compare(strLow, pos, strCap, pos, 1, new CultureInfo("en-US"), CompareOptions.None);
      if (x < 0) result = "less than";
      else if (x > 0) result = "greater than";
      outputBlock.Text += String.Format("Compare(\"{0}\"[{2}], \"{1}\"[{2}]):", strLow, strCap, pos) + "\n";
      outputBlock.Text += String.Format("   '{0}' is {1} '{2}'", strLow[pos], result, strCap[pos]) + "\n";
   }
}


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Community Additions

ADD
Show:
© 2014 Microsoft