This documentation is archived and is not being maintained.

CompareInfo.Name Property

Gets the name of the culture used for sorting operations by this CompareInfo object.

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

'Declaration
<ComVisibleAttribute(False)> _
Public Overridable ReadOnly Property Name As String
'Usage
Dim instance As CompareInfo 
Dim value As String 

value = instance.Name

Property Value

Type: System.String
The name of a culture.

The Name and CultureInfo.Name properties can have different values. For example, an LCID property value of hexadecimal 0x10407 identifies an alternate sort culture that sorts names as they might appear in a German telephone book. The Name property has a value of "de-de_phoneb" while the CultureInfo.Name property of the associated German (Germany) culture has a value of "de-DE".

The following code example compares three strings using the fr-FR and ja-JP cultures. The Name property is used to display the name of each culture.

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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: