Export (0) Print
Expand All

CompareInfo.IndexOf Method (String, Char, Int32, Int32, CompareOptions)

Searches for the specified character and returns the zero-based index of the first occurrence within the section of the source string that starts at the specified index and contains the specified number of elements using the specified CompareOptions value.

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

public virtual int IndexOf (
	string source,
	char value,
	int startIndex,
	int count,
	CompareOptions options
)
public int IndexOf (
	String source, 
	char value, 
	int startIndex, 
	int count, 
	CompareOptions options
)
public function IndexOf (
	source : String, 
	value : char, 
	startIndex : int, 
	count : int, 
	options : CompareOptions
) : int

Parameters

source

The string to search.

value

The character to locate within source.

startIndex

The zero-based starting index of the search.

count

The number of elements in the section to search.

options

The CompareOptions value that defines how source and value should be compared. options is either the value Ordinal used by itself, or the bitwise combination of one or more of the following values: IgnoreCase, IgnoreSymbols, IgnoreNonSpace, IgnoreWidth, and IgnoreKanaType.

Return Value

The zero-based index of the first occurrence of value within the section of source that starts at startIndex and contains the number of elements specified by count, using the specified CompareOptions value, if found; otherwise, -1.

Exception typeCondition

ArgumentNullException

source is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

startIndex is outside the range of valid indexes for source.

-or-

count is less than zero.

-or-

startIndex and count do not specify a valid section in source.

ArgumentException

options contains an invalid CompareOptions value.

The source string is searched forward starting at startIndex and ending at startIndex + count - 1.

The CompareOptions.StringSort value is not valid for this method.

If options does not include the Ordinal value, this overload performs a culture-sensitive search; that is, if the char is a Unicode value representing a precomposed character, such as the ligature 'Æ' (U+00C6), it might be considered equivalent to any occurrence of its components in the correct sequence, such as "AE" (U+0041, U+0045), depending on the culture. If options includes the Ordinal value, this overload performs an ordinal (culture-insensitive) search; that is, a char is considered equivalent to another char only if the Unicode values are the same. Overloads of String.IndexOf that search for a char perform an ordinal search, while those that search for a string perform a culture-sensitive search.

The following code example determines the indexes of the first and last occurrences of a character or a substring within a portion of a string.

using System;
using System.Globalization;

public class SamplesCompareInfo  {

   public static void Main()  {

      // Creates CompareInfo for the InvariantCulture.
      CompareInfo myComp = CultureInfo.InvariantCulture.CompareInfo;

      // iS is the starting index of the substring.
      int iS = 8;
      // iL is the length of the substring.
      int iL = 18;
      // myT1 and myT2 are the strings used for padding.
      String myT1 = new String( '-', iS );
      String myT2;

      // Searches for the ligature Æ.
      String myStr = "Is AE or ae the same as Æ or æ?";
      myT2 = new String( '-', myStr.Length - iS - iL );
      Console.WriteLine();
      Console.WriteLine( "Original      : {0}", myStr );
      Console.WriteLine( "No options    : {0}{1}{2}", myT1, myStr.Substring( iS, iL ), myT2 );
      PrintMarker( "           AE : ", myComp.IndexOf( myStr, "AE", iS, iL ), myComp.LastIndexOf( myStr, "AE", iS + iL - 1, iL ) );
      PrintMarker( "           ae : ", myComp.IndexOf( myStr, "ae", iS, iL ), myComp.LastIndexOf( myStr, "ae", iS + iL - 1, iL ) );
      PrintMarker( "            Æ : ", myComp.IndexOf( myStr, 'Æ', iS, iL ), myComp.LastIndexOf( myStr, 'Æ', iS + iL - 1, iL ) );
      PrintMarker( "            æ : ", myComp.IndexOf( myStr, 'æ', iS, iL ), myComp.LastIndexOf( myStr, 'æ', iS + iL - 1, iL ) );
      Console.WriteLine( "Ordinal       : {0}{1}{2}", myT1, myStr.Substring( iS, iL ), myT2 );
      PrintMarker( "           AE : ", myComp.IndexOf( myStr, "AE", iS, iL, CompareOptions.Ordinal ), myComp.LastIndexOf( myStr, "AE", iS + iL - 1, iL, CompareOptions.Ordinal ) );
      PrintMarker( "           ae : ", myComp.IndexOf( myStr, "ae", iS, iL, CompareOptions.Ordinal ), myComp.LastIndexOf( myStr, "ae", iS + iL - 1, iL, CompareOptions.Ordinal ) );
      PrintMarker( "            Æ : ", myComp.IndexOf( myStr, 'Æ', iS, iL, CompareOptions.Ordinal ), myComp.LastIndexOf( myStr, 'Æ', iS + iL - 1, iL, CompareOptions.Ordinal ) );
      PrintMarker( "            æ : ", myComp.IndexOf( myStr, 'æ', iS, iL, CompareOptions.Ordinal ), myComp.LastIndexOf( myStr, 'æ', iS + iL - 1, iL, CompareOptions.Ordinal ) );
      Console.WriteLine( "IgnoreCase    : {0}{1}{2}", myT1, myStr.Substring( iS, iL ), myT2 );
      PrintMarker( "           AE : ", myComp.IndexOf( myStr, "AE", iS, iL, CompareOptions.IgnoreCase ), myComp.LastIndexOf( myStr, "AE", iS + iL - 1, iL, CompareOptions.IgnoreCase ) );
      PrintMarker( "           ae : ", myComp.IndexOf( myStr, "ae", iS, iL, CompareOptions.IgnoreCase ), myComp.LastIndexOf( myStr, "ae", iS + iL - 1, iL, CompareOptions.IgnoreCase ) );
      PrintMarker( "            Æ : ", myComp.IndexOf( myStr, 'Æ', iS, iL, CompareOptions.IgnoreCase ), myComp.LastIndexOf( myStr, 'Æ', iS + iL - 1, iL, CompareOptions.IgnoreCase ) );
      PrintMarker( "            æ : ", myComp.IndexOf( myStr, 'æ', iS, iL, CompareOptions.IgnoreCase ), myComp.LastIndexOf( myStr, 'æ', iS + iL - 1, iL, CompareOptions.IgnoreCase ) );

      // Searches for the combining character sequence Latin capital letter U with diaeresis or Latin small letter u with diaeresis.
      myStr = "Is \u0055\u0308 or \u0075\u0308 the same as \u00DC or \u00FC?";
      myT2 = new String( '-', myStr.Length - iS - iL );
      Console.WriteLine();
      Console.WriteLine( "Original      : {0}", myStr );
      Console.WriteLine( "No options    : {0}{1}{2}", myT1, myStr.Substring( iS, iL ), myT2 );
      PrintMarker( "           U\u0308 : ", myComp.IndexOf( myStr, "U\u0308", iS, iL ), myComp.LastIndexOf( myStr, "U\u0308", iS + iL - 1, iL ) );
      PrintMarker( "           u\u0308 : ", myComp.IndexOf( myStr, "u\u0308", iS, iL ), myComp.LastIndexOf( myStr, "u\u0308", iS + iL - 1, iL ) );
      PrintMarker( "            Ü : ", myComp.IndexOf( myStr, 'Ü', iS, iL ), myComp.LastIndexOf( myStr, 'Ü', iS + iL - 1, iL ) );
      PrintMarker( "            ü : ", myComp.IndexOf( myStr, 'ü', iS, iL ), myComp.LastIndexOf( myStr, 'ü', iS + iL - 1, iL ) );
      Console.WriteLine( "Ordinal       : {0}{1}{2}", myT1, myStr.Substring( iS, iL ), myT2 );
      PrintMarker( "           U\u0308 : ", myComp.IndexOf( myStr, "U\u0308", iS, iL, CompareOptions.Ordinal ), myComp.LastIndexOf( myStr, "U\u0308", iS + iL - 1, iL, CompareOptions.Ordinal ) );
      PrintMarker( "           u\u0308 : ", myComp.IndexOf( myStr, "u\u0308", iS, iL, CompareOptions.Ordinal ), myComp.LastIndexOf( myStr, "u\u0308", iS + iL - 1, iL, CompareOptions.Ordinal ) );
      PrintMarker( "            Ü : ", myComp.IndexOf( myStr, 'Ü', iS, iL, CompareOptions.Ordinal ), myComp.LastIndexOf( myStr, 'Ü', iS + iL - 1, iL, CompareOptions.Ordinal ) );
      PrintMarker( "            ü : ", myComp.IndexOf( myStr, 'ü', iS, iL, CompareOptions.Ordinal ), myComp.LastIndexOf( myStr, 'ü', iS + iL - 1, iL, CompareOptions.Ordinal ) );
      Console.WriteLine( "IgnoreCase    : {0}{1}{2}", myT1, myStr.Substring( iS, iL ), myT2 );
      PrintMarker( "           U\u0308 : ", myComp.IndexOf( myStr, "U\u0308", iS, iL, CompareOptions.IgnoreCase ), myComp.LastIndexOf( myStr, "U\u0308", iS + iL - 1, iL, CompareOptions.IgnoreCase ) );
      PrintMarker( "           u\u0308 : ", myComp.IndexOf( myStr, "u\u0308", iS, iL, CompareOptions.IgnoreCase ), myComp.LastIndexOf( myStr, "u\u0308", iS + iL - 1, iL, CompareOptions.IgnoreCase ) );
      PrintMarker( "            Ü : ", myComp.IndexOf( myStr, 'Ü', iS, iL, CompareOptions.IgnoreCase ), myComp.LastIndexOf( myStr, 'Ü', iS + iL - 1, iL, CompareOptions.IgnoreCase ) );
      PrintMarker( "            ü : ", myComp.IndexOf( myStr, 'ü', iS, iL, CompareOptions.IgnoreCase ), myComp.LastIndexOf( myStr, 'ü', iS + iL - 1, iL, CompareOptions.IgnoreCase ) );

   }

   public static void PrintMarker( String Prefix, int First, int Last )  {

      // Determines the size of the array to create.
      int mySize;
      if ( Last > First )
         mySize = Last;
      else
         mySize = First;

      if ( mySize > -1 )  {

         // Creates an array of Char to hold the markers.
         Char[] myCharArr = new Char[mySize+1];

         // Inserts the appropriate markers.
         if ( First > -1 )
         myCharArr[First] = 'f';
         if ( Last > -1 )
            myCharArr[Last] = 'l';
         if ( First == Last )
         myCharArr[First] = 'b';

         // Displays the array of Char as a String.
         Console.WriteLine( "{0}{1}", Prefix, new String( myCharArr ) );

      }
      else
         Console.WriteLine( Prefix );

   }

}


/*
This code produces the following output.

Original      : Is AE or ae the same as Æ or æ?
No options    : -------- ae the same as Æ -----
           AE :                         b
           ae :          b
            Æ :                         b
            æ :          b
Ordinal       : -------- ae the same as Æ -----
           AE :
           ae :          b
            Æ :                         b
            æ :
IgnoreCase    : -------- ae the same as Æ -----
           AE :          f              l
           ae :          f              l
            Æ :          f              l
            æ :          f              l

Original      : Is U" or u" the same as Ü or ü?
No options    : -------- u" the same as Ü -----
           U" :                         b
           u" :          b
            Ü :                         b
            ü :          b
Ordinal       : -------- u" the same as Ü -----
           U" :
           u" :          b
            Ü :                         b
            ü :
IgnoreCase    : -------- u" the same as Ü -----
           U" :          f              l
           u" :          f              l
            Ü :          f              l
            ü :          f              l

*/

import System.* ;
import System.Globalization.* ;

public class SamplesCompareInfo
{
	public static void main(String[] args)
	{
		// Creates CompareInfo for the InvariantCulture.
		CompareInfo myComp = 
			CultureInfo.get_InvariantCulture().get_CompareInfo();

		// iS is the starting index of the substring.
		int iS = 8;
		// iL is the length of the substring.
		int iL = 18;
		// myT1 and myT2 are the strings used for padding.
		String myT1 =  new String('-', iS);
		String myT2;

		// Searches for the ligature .
		String myStr = "Is AE or ae the same as Æ or æ?";
		myT2 = new String('-', myStr.length() - iS - iL);
		Console.WriteLine();
		Console.WriteLine("Original      : {0}", myStr);
		Console.WriteLine("No options    : {0}{1}{2}", 
			myT1, myStr.Substring(iS, iL), myT2);
		PrintMarker("           AE : ", myComp.IndexOf(myStr, "AE", iS, iL), 
			myComp.LastIndexOf(myStr, "AE", iS + iL - 1, iL));
		PrintMarker("           ae : ", myComp.IndexOf(myStr, "ae", iS, iL),
			myComp.LastIndexOf(myStr, "ae", iS + iL - 1, iL));
		PrintMarker("            Æ : ", myComp.IndexOf(myStr, 'Æ', iS, iL),
			myComp.LastIndexOf(myStr, 'Æ', iS + iL - 1, iL));
		PrintMarker("            æ : ", myComp.IndexOf(myStr,'æ', iS, iL),
			myComp.LastIndexOf(myStr, 'æ', iS + iL - 1, iL));
		Console.WriteLine("Ordinal       : {0}{1}{2}", myT1, 
			myStr.Substring(iS, iL), myT2);
		PrintMarker("           AE : ", myComp.IndexOf(myStr, "AE", iS, iL, 
			CompareOptions.Ordinal), myComp.LastIndexOf(myStr, "AE", 
			iS + iL - 1, iL, CompareOptions.Ordinal));
		PrintMarker("           ae : ", myComp.IndexOf(myStr, "ae", iS, iL,
			CompareOptions.Ordinal), myComp.LastIndexOf(myStr, "ae", 
			iS + iL - 1, iL, CompareOptions.Ordinal));
		PrintMarker("            Æ : ", myComp.IndexOf(myStr, 'Æ', iS, iL, 
			CompareOptions.Ordinal), myComp.LastIndexOf(myStr, 'Æ', 
			iS + iL - 1, iL, CompareOptions.Ordinal));
		PrintMarker("            æ : ", myComp.IndexOf(myStr, 'æ', iS, iL,
			CompareOptions.Ordinal), myComp.LastIndexOf(myStr,'æ', 
			iS + iL - 1, iL, CompareOptions.Ordinal));
		Console.WriteLine("IgnoreCase    : {0}{1}{2}", myT1,
			myStr.Substring(iS, iL), myT2);
		PrintMarker("           AE : ", myComp.IndexOf(myStr, "AE", iS, iL, 
			CompareOptions.IgnoreCase), myComp.LastIndexOf(myStr, "AE", 
			iS + iL - 1, iL, CompareOptions.IgnoreCase));
		PrintMarker("           ae : ", myComp.IndexOf(myStr, "ae", iS, iL, 
			CompareOptions.IgnoreCase), myComp.LastIndexOf(myStr, "ae", 
			iS + iL - 1, iL, CompareOptions.IgnoreCase));
		PrintMarker("            Æ : ", myComp.IndexOf(myStr, 'Æ', iS, iL, 
			CompareOptions.IgnoreCase), myComp.LastIndexOf(myStr, 'Æ', 
			iS + iL - 1, iL, CompareOptions.IgnoreCase));
		PrintMarker("            æ : ", myComp.IndexOf(myStr, 'æ', iS, iL, 
			CompareOptions.IgnoreCase),
			myComp.LastIndexOf(myStr, 'æ', 
			iS + iL - 1, iL, CompareOptions.IgnoreCase));

		// Searches for the combining character sequence Latin capital letter 
		// U with diaeresis or Latin small letter u with diaeresis.
		myStr = "Is \u0055\u0308 or \u0075\u0308 the same as \u00DC or \u00FC?";
		myT2 = new String('-', myStr.length() - iS - iL);
		Console.WriteLine();
		Console.WriteLine("Original      : {0}", myStr);
		Console.WriteLine("No options    : {0}{1}{2}", myT1, 
			myStr.Substring(iS, iL), myT2);
		PrintMarker("           U\u0308 : ", 
			myComp.IndexOf(myStr, "U\u0308", iS, iL), 
			myComp.LastIndexOf(myStr, "U\u0308", iS + iL - 1, iL));
		PrintMarker("           u\u0308 : ", 
			myComp.IndexOf(myStr, "u\u0308", iS, iL), 
			myComp.LastIndexOf(myStr, "u\u0308", iS + iL - 1, iL));
		PrintMarker("            Ü : ", myComp.IndexOf(myStr,'Ü', iS, iL), 
			myComp.LastIndexOf(myStr, 'Ü', iS + iL - 1, iL));
		PrintMarker("            ü : ", myComp.IndexOf(myStr,'ü', iS, iL), 
			myComp.LastIndexOf(myStr,'ü', iS + iL - 1, iL));
		Console.WriteLine("Ordinal       : {0}{1}{2}", myT1, 
			myStr.Substring(iS, iL), myT2);
		PrintMarker("           U\u0308 : ", 
			myComp.IndexOf(myStr, "U\u0308", iS, iL, CompareOptions.Ordinal), 
			myComp.LastIndexOf(myStr, "U\u0308", iS + iL - 1, iL,
			CompareOptions.Ordinal));
		PrintMarker("           u\u0308 : ",
			myComp.IndexOf(myStr, "u\u0308", iS, iL, CompareOptions.Ordinal), 
			myComp.LastIndexOf(myStr, "u\u0308", iS + iL - 1, iL, 
			CompareOptions.Ordinal));
		PrintMarker("            Ü : ", 
			myComp.IndexOf(myStr, 'Ü', iS, iL, CompareOptions.Ordinal), 
			myComp.LastIndexOf(myStr, 'Ü', iS + iL - 1, iL, 
			CompareOptions.Ordinal));
		PrintMarker("            ü : ", 
			myComp.IndexOf(myStr, 'ü', iS, iL, CompareOptions.Ordinal), 
			myComp.LastIndexOf(myStr, 'ü', iS + iL - 1, iL, 
			CompareOptions.Ordinal));
		Console.WriteLine("IgnoreCase    : {0}{1}{2}", myT1, 
			myStr.Substring(iS, iL), myT2);
		PrintMarker("           U\u0308 : ", myComp.IndexOf(myStr, "U\u0308",
			iS, iL, CompareOptions.IgnoreCase), 
			myComp.LastIndexOf(myStr, "U\u0308", iS + iL - 1, iL, 
			CompareOptions.IgnoreCase));
		PrintMarker("           u\u0308 : ", 
			myComp.IndexOf(myStr, "u\u0308", iS, iL, CompareOptions.IgnoreCase),
			myComp.LastIndexOf(myStr, "u\u0308", iS + iL - 1, iL, 
			CompareOptions.IgnoreCase));
		PrintMarker("            Ü : ", 
			myComp.IndexOf(myStr, 'Ü', iS, iL, CompareOptions.IgnoreCase),
			myComp.LastIndexOf(myStr, 'Ü', iS + iL - 1, iL, 
			CompareOptions.IgnoreCase));
		PrintMarker("            ü : ",
			myComp.IndexOf(myStr,'ü', iS, iL, CompareOptions.IgnoreCase), 
			myComp.LastIndexOf(myStr, 'ü', iS + iL - 1, iL, 
			CompareOptions.IgnoreCase));
	} //main

	public static void PrintMarker(String Prefix, int First, int Last)
	{
		// Determines the size of the array to create.
		int mySize;
		if (Last > First) {
			mySize = Last;
		}
		else {
			mySize = First;
		} 
		if (mySize > -1) {
		        
			// Creates an array of Char to hold the markers.
			char myCharArr[] = new char[mySize + 1];
		        
			// Inserts the appropriate markers.
			if (First > -1) {
				myCharArr [First]= 'f' ;
			}
			if (Last > -1) {
				myCharArr[Last]= 'l' ;
			}
			if (First == Last) {
				myCharArr[First]= 'b' ;
			}
		        
			// Displays the array of Char as a String.
			Console.WriteLine("{0}{1}", Prefix, new String(myCharArr));
		}
		else {
			Console.WriteLine(Prefix);
		} 
	} //PrintMarker
} //SamplesCompareInfo

/*
This code produces the following output.

Original      : Is AE or ae the same as Æ or æ?
No options    : -------- ae the same as Æ -----
           AE :                         b
           ae :          b
            Æ :                         b
            æ :          b
Ordinal       : -------- ae the same as Æ -----
           AE :
           ae :          b
            Æ :                         b
            æ :
IgnoreCase    : -------- ae the same as Æ -----
           AE :          f              l
           ae :          f              l
            Æ :          f              l
            æ :          f              l

Original      : Is U" or u" the same as Ü or ü?
No options    : -------- u" the same as Ü -----
           U" :                         b
           u" :          b
            Ü :                         b
            ü :          b
Ordinal       : -------- u" the same as Ü -----
           U" :
           u" :          b
            Ü :                         b
            ü :
IgnoreCase    : -------- u" the same as Ü -----
           U" :          f              l
           u" :          f              l
            Ü :          f              l
            ü :          f              l
*/

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft