Export (0) Print
Expand All

CompareInfo.Compare Method (String, Int32, String, Int32, CompareOptions)

Compares the end section of a string with the end section of another string using the specified CompareOptions value.

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

public virtual int Compare (
	string string1,
	int offset1,
	string string2,
	int offset2,
	CompareOptions options
)
public int Compare (
	String string1, 
	int offset1, 
	String string2, 
	int offset2, 
	CompareOptions options
)
public function Compare (
	string1 : String, 
	offset1 : int, 
	string2 : String, 
	offset2 : int, 
	options : CompareOptions
) : int
Not applicable.

Parameters

string1

The first string to compare.

offset1

The zero-based index of the character in string1 at which to start comparing.

string2

The second string to compare.

offset2

The zero-based index of the character in string2 at which to start comparing.

options

The CompareOptions value that defines how string1 and string2 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, IgnoreKanaType, and StringSort.

Return Value

Value

Condition

zero

The two strings are equal.

less than zero

The specified section of string1 is less than the specified section of string2.

greater than zero

The specified section of string1 is greater than the specified section of string2.

Exception typeCondition

ArgumentOutOfRangeException

offset1 or offset2 is less than zero.

-or-

offset1 is greater than or equal to the number of characters in string1.

-or-

offset2 is greater than or equal to the number of characters in string2.

ArgumentException

options contains an invalid CompareOptions value.

If a security decision depends on a string comparison or a case change, the application should use the InvariantCulture to ensure that the behavior is consistent regardless of the culture settings of the operating system.

The following code example compares portions of two strings using different CompareOptions settings.

using System;
using System.Globalization;

public class SamplesCompareInfo  {

   public static void Main()  {

      // Defines the strings to compare.
      String myStr1 = "My Uncle Bill's clients";
      String myStr2 = "My uncle bills clients";

      // Creates a CompareInfo that uses the InvariantCulture.
      CompareInfo myComp = CultureInfo.InvariantCulture.CompareInfo;

      // Compares two strings using myComp.
      Console.WriteLine( "Comparing \"{0}\" and \"{1}\"", myStr1.Substring( 10 ), myStr2.Substring( 10 ) );
      Console.WriteLine( "   With no CompareOptions            : {0}", myComp.Compare( myStr1, 10, myStr2, 10 ) );
      Console.WriteLine( "   With None                         : {0}", myComp.Compare( myStr1, 10, myStr2, 10, CompareOptions.None ) );
      Console.WriteLine( "   With Ordinal                      : {0}", myComp.Compare( myStr1, 10, myStr2, 10, CompareOptions.Ordinal ) );
      Console.WriteLine( "   With StringSort                   : {0}", myComp.Compare( myStr1, 10, myStr2, 10, CompareOptions.StringSort ) );
      Console.WriteLine( "   With IgnoreCase                   : {0}", myComp.Compare( myStr1, 10, myStr2, 10, CompareOptions.IgnoreCase ) );
      Console.WriteLine( "   With IgnoreSymbols                : {0}", myComp.Compare( myStr1, 10, myStr2, 10, CompareOptions.IgnoreSymbols ) );
      Console.WriteLine( "   With IgnoreCase and IgnoreSymbols : {0}", myComp.Compare( myStr1, 10, myStr2, 10, CompareOptions.IgnoreCase | CompareOptions.IgnoreSymbols ) );

   }

}


/*
This code produces the following output.

Comparing "ill's clients" and "ills clients"
   With no CompareOptions            : 1
   With None                         : 1
   With Ordinal                      : -76
   With StringSort                   : -1
   With IgnoreCase                   : 1
   With IgnoreSymbols                : 0
   With IgnoreCase and IgnoreSymbols : 0

*/

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

public class SamplesCompareInfo
{
    public static void main(String[] args)
    {
        // Defines the strings to compare.
        String myStr1 = "My Uncle Bill's clients";
        String myStr2 = "My uncle bills clients";

        // Creates a CompareInfo that uses the InvariantCulture.
        CompareInfo myComp = 
            CultureInfo.get_InvariantCulture().get_CompareInfo();

        // Compares two strings using myComp.
        Console.WriteLine("Comparing \"{0}\" and \"{1}\"", 
            myStr1.Substring(10), myStr2.Substring(10));
        Console.WriteLine("   With no CompareOptions            : {0}",
            System.Convert.ToString(myComp.Compare(myStr1, 10, myStr2, 10)));
        Console.WriteLine("   With None                         : {0}", 
            System.Convert.ToString(myComp.Compare(myStr1, 10, myStr2, 10, 
            CompareOptions.None)));
        Console.WriteLine("   With Ordinal                      : {0}", 
            System.Convert.ToString(myComp.Compare(myStr1, 10, myStr2, 10, 
            CompareOptions.Ordinal)));
        Console.WriteLine("   With StringSort                   : {0}", 
            System.Convert.ToString(myComp.Compare(myStr1, 10, myStr2, 10, 
            CompareOptions.StringSort)));
        Console.WriteLine("   With IgnoreCase                   : {0}", 
            System.Convert.ToString(myComp.Compare(myStr1, 10, myStr2, 10, 
            CompareOptions.IgnoreCase)));
        Console.WriteLine("   With IgnoreSymbols                : {0}", 
            System.Convert.ToString(myComp.Compare(myStr1, 10, myStr2, 10, 
            CompareOptions.IgnoreSymbols)));
        Console.WriteLine("   With IgnoreCase and IgnoreSymbols : {0}", 
            System.Convert.ToString(myComp.Compare(myStr1, 10, myStr2, 10, 
            CompareOptions.IgnoreCase | CompareOptions.IgnoreSymbols)));
    } //main 
} //SamplesCompareInfo

/*
This code produces the following output.

Comparing "ill's clients" and "ills clients"
   With no CompareOptions            : 1
   With None                         : 1
   With Ordinal                      : -76
   With StringSort                   : -1
   With IgnoreCase                   : 1
   With IgnoreSymbols                : 0
   With IgnoreCase and IgnoreSymbols : 0
*/

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft