Export (0) Print
Expand All

CompareInfo.Compare Method (String, String)

Compares two strings.

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

'Declaration
Public Overridable Function Compare ( _
	string1 As String, _
	string2 As String _
) As Integer
'Usage
Dim instance As CompareInfo
Dim string1 As String
Dim string2 As String
Dim returnValue As Integer

returnValue = instance.Compare(string1, string2)
public int Compare (
	String string1, 
	String string2
)
public function Compare (
	string1 : String, 
	string2 : String
) : int

Parameters

string1

The first string to compare.

string2

The second string to compare.

Return Value

Value

Condition

zero

The two strings are equal.

less than zero

string1 is less than string2.

greater than zero

string1 is greater than string2.

The comparison is performed, by default, using None. 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 two strings using the different CompareInfo instances: a CompareInfo instance associated with the "Spanish - Spain" culture with international sort, a CompareInfo instance associated with the "Spanish - Spain" culture with traditional sort, and a CompareInfo instance associated with the InvariantCulture.

' The following code example compares two strings using the different CompareInfo instances:
'    a CompareInfo instance associated with the "Spanish - Spain" culture with international sort,
'    a CompareInfo instance associated with the "Spanish - Spain" culture with traditional sort, and
'    a CompareInfo instance associated with the InvariantCulture.

Imports System
Imports System.Globalization

Public Class SamplesCompareInfo

   Public Shared Sub Main()

      ' Defines the strings to compare.
      Dim myStr1 As [String] = "calle"
      Dim myStr2 As [String] = "calor"

      ' Uses GetCompareInfo to create the CompareInfo that uses the "es-ES" culture with international sort.
      Dim myCompIntl As CompareInfo = CompareInfo.GetCompareInfo("es-ES")

      ' Uses GetCompareInfo to create the CompareInfo that uses the "es-ES" culture with traditional sort.
      Dim myCompTrad As CompareInfo = CompareInfo.GetCompareInfo(&H40A)

      ' Uses the CompareInfo property of the InvariantCulture.
      Dim myCompInva As CompareInfo = CultureInfo.InvariantCulture.CompareInfo

      ' Compares two strings using myCompIntl.
      Console.WriteLine("Comparing ""{0}"" and ""{1}""", myStr1, myStr2)
      Console.WriteLine("   With myCompIntl.Compare: {0}", myCompIntl.Compare(myStr1, myStr2))
      Console.WriteLine("   With myCompTrad.Compare: {0}", myCompTrad.Compare(myStr1, myStr2))
      Console.WriteLine("   With myCompInva.Compare: {0}", myCompInva.Compare(myStr1, myStr2))

   End Sub 'Main 

End Class 'SamplesCompareInfo


'This code produces the following output.
'
'Comparing "calle" and "calor"
'   With myCompIntl.Compare: -1
'   With myCompTrad.Compare: 1
'   With myCompInva.Compare: -1


// The following code example compares two strings using the different 
// CompareInfo instances:
//    a CompareInfo instance associated with the "Spanish - Spain" 
// culture with international sort,
//    a CompareInfo instance associated with the "Spanish - Spain" 
// culture with traditional sort, and
//    a CompareInfo instance associated with the InvariantCulture.

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

public class SamplesCompareInfo
{
    public static void main(String[] args)
    {
        // Defines the strings to compare.
        String myStr1 = "calle";
        String myStr2 = "calor";

        // Uses GetCompareInfo to create the CompareInfo that uses the "es-ES" 
        // culture with international sort.
        CompareInfo myCompIntl = CompareInfo.GetCompareInfo("es-ES");

        // Uses GetCompareInfo to create the CompareInfo that uses the "es-ES" 
        // culture with traditional sort.
        CompareInfo myCompTrad = CompareInfo.GetCompareInfo(0x40A);

        // Uses the CompareInfo property of the InvariantCulture.
        CompareInfo myCompInva = CultureInfo.get_InvariantCulture()
            .get_CompareInfo();

        // Compares two strings using myCompIntl.
        Console.WriteLine("Comparing \"{0}\" and \"{1}\"", myStr1, myStr2);
        Console.WriteLine("   With myCompIntl.Compare: {0}",
            System.Convert.ToString( myCompIntl.Compare(myStr1, myStr2)));
        Console.WriteLine("   With myCompTrad.Compare: {0}", 
            System.Convert.ToString(myCompTrad.Compare(myStr1, myStr2)));
        Console.WriteLine("   With myCompInva.Compare: {0}", 
            System.Convert.ToString(myCompInva.Compare(myStr1, myStr2)));
    } //main 
} //SamplesCompareInfo

/*
This code produces the following output.

Comparing "calle" and "calor"
   With myCompIntl.Compare: -1
   With myCompTrad.Compare: 1
   With myCompInva.Compare: -1
*/

The following code example demonstrates calling the Compare method.

Imports System
Imports System.Text
Imports System.Globalization

NotInheritable Public Class App
    Shared Sub Main(ByVal args() As String) 
        Dim sign() As String = {"<", "=", ">"}
        
        ' The code below demonstrates how strings compare 
        ' differently for different cultures.
        Dim s1 As String = "Coté"
        Dim s2 As String = "coté"
        Dim s3 As String = "côte"
        
        ' Set sort order of strings for French in France.
        Dim ci As CompareInfo = New CultureInfo("fr-FR").CompareInfo
        Console.WriteLine("The LCID for {0} is {1}.", ci.Name, ci.LCID)
        
        ' Display the result using fr-FR Compare of Coté = coté.  	
        Console.WriteLine("fr-FR Compare: {0} {2} {1}", _
                          s1, s2, sign((ci.Compare(s1, s2, CompareOptions.IgnoreCase) + 1)))
        
        ' Display the result using fr-FR Compare of coté > côte.
        Console.WriteLine("fr-FR Compare: {0} {2} {1}", _
                          s2, s3, sign((ci.Compare(s2, s3, CompareOptions.None) + 1)))
        
        ' Set sort order of strings for Japanese as spoken in Japan.
        ci = New CultureInfo("ja-JP").CompareInfo
        Console.WriteLine("The LCID for {0} is {1}.", ci.Name, ci.LCID)
        
        ' Display the result using ja-JP Compare of coté < côte. 
        Console.WriteLine("ja-JP Compare: {0} {2} {1}", _
                          s2, s3, sign((ci.Compare(s2, s3) + 1)))
    End Sub 'Main
End Class 'App

' This code produces the following output.
' 
' The LCID for fr-FR is 1036.
' fr-FR Compare: Coté = coté
' fr-FR Compare: coté > côte
' The LCID for ja-JP is 1041.
' ja-JP Compare: coté < côte

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