Export (0) Print
Expand All

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

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

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

'Declaration
Public Overridable Function Compare ( _
	string1 As String, _
	offset1 As Integer, _
	length1 As Integer, _
	string2 As String, _
	offset2 As Integer, _
	length2 As Integer, _
	options As CompareOptions _
) As Integer
'Usage
Dim instance As CompareInfo
Dim string1 As String
Dim offset1 As Integer
Dim length1 As Integer
Dim string2 As String
Dim offset2 As Integer
Dim length2 As Integer
Dim options As CompareOptions
Dim returnValue As Integer

returnValue = instance.Compare(string1, offset1, length1, string2, offset2, length2, options)
public int Compare (
	String string1, 
	int offset1, 
	int length1, 
	String string2, 
	int offset2, 
	int length2, 
	CompareOptions options
)
public function Compare (
	string1 : String, 
	offset1 : int, 
	length1 : int, 
	string2 : String, 
	offset2 : int, 
	length2 : int, 
	options : CompareOptions
) : int

Parameters

string1

The first string to compare.

offset1

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

length1

The number of consecutive characters in string1 to compare.

string2

The second string to compare.

offset2

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

length2

The number of consecutive characters in string2 to compare.

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 length1 or offset2 or length2 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.

-or-

length1 is greater than the number of characters from offset1 to the end of string1.

-or-

length2 is greater than the number of characters from offset2 to the end of string2.

ArgumentException

options contains an invalid CompareOptions value.

If a security decision depends on a string comparison or a case-change operation, use the InvariantCulture to ensure that the behavior will be consistent regardless of the culture settings of the system.

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

Imports System
Imports System.Globalization

Public Class SamplesCompareInfo

   Public Shared Sub Main()

      ' Defines the strings to compare.
      Dim myStr1 As [String] = "My Uncle Bill's clients"
      Dim myStr2 As [String] = "My uncle bills clients"

      ' Creates a CompareInfo that uses the InvariantCulture.
      Dim myComp As CompareInfo = CultureInfo.InvariantCulture.CompareInfo

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

   End Sub 'Main 

End Class 'SamplesCompareInfo


'This code produces the following output.
'
'Comparing "Uncle Bill" and "uncle bill"
'   With no CompareOptions            : 1
'   With None                         : 1
'   With Ordinal                      : -32
'   With StringSort                   : 1
'   With IgnoreCase                   : 0
'   With IgnoreSymbols                : 1
'   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(3, 10), myStr2.Substring(3, 10));
        Console.WriteLine("   With no CompareOptions            : {0}", 
            System.Convert.ToString(myComp.Compare(
            myStr1, 3, 10, myStr2, 3, 10)));
        Console.WriteLine("   With None                         : {0}", 
            System.Convert.ToString(myComp.Compare(
            myStr1, 3, 10, myStr2, 3, 10, CompareOptions.None)));
        Console.WriteLine("   With Ordinal                      : {0}", 
            System.Convert.ToString(myComp.Compare(
            myStr1, 3, 10, myStr2, 3, 10, CompareOptions.Ordinal)));
        Console.WriteLine("   With StringSort                   : {0}", 
            System.Convert.ToString(myComp.Compare(
            myStr1, 3, 10, myStr2, 3, 10, CompareOptions.StringSort)));
        Console.WriteLine("   With IgnoreCase                   : {0}", 
            System.Convert.ToString(myComp.Compare(
            myStr1, 3, 10, myStr2, 3, 10, CompareOptions.IgnoreCase)));
        Console.WriteLine("   With IgnoreSymbols                : {0}", 
            System.Convert.ToString(myComp.Compare(
            myStr1, 3, 10, myStr2, 3, 10, CompareOptions.IgnoreSymbols)));
        Console.WriteLine("   With IgnoreCase and IgnoreSymbols : {0}", 
            System.Convert.ToString(myComp.Compare(
            myStr1, 3, 10, myStr2, 3, 10, 
            CompareOptions.IgnoreCase | CompareOptions.IgnoreSymbols)));
    } //main 
} //SamplesCompareInfo

/*
This code produces the following output.

Comparing "Uncle Bill" and "uncle bill"
   With no CompareOptions            : 1
   With None                         : 1
   With Ordinal                      : -32
   With StringSort                   : 1
   With IgnoreCase                   : 0
   With IgnoreSymbols                : 1
   With IgnoreCase and IgnoreSymbols : 0
*/

Windows 98, Windows 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 .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