This documentation is archived and is not being maintained.

StringComparer.Ordinal Property

Updated: May 2010

Gets a StringComparer object that performs a case-sensitive ordinal string comparison.

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

Public Shared ReadOnly Property Ordinal As StringComparer
Dim value As StringComparer 

value = StringComparer.Ordinal

Property Value

Type: System.StringComparer
A StringComparer object.

The StringComparer returned by the Ordinal property performs a simple byte comparison that is independent of language. This is most appropriate when comparing strings that are generated programmatically or when comparing case-sensitive resources such as passwords.

The Ordinal property actually returns an instance of an anonymous class derived from the StringComparer class.

The following code example demonstrates the properties and the Create method of the StringComparer class. The example illustrates how different StringComparer objects sort three versions of the Latin letter I.

' This code example demonstrates members of the System.StringComparer class. 

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Globalization
Imports System.Threading

Class Sample

    Public Shared Sub Main() 
        ' Create a list of string. 
        Dim list As New List(Of String) 

        ' Get the tr-TR (Turkish-Turkey) culture. 
        Dim turkish As New CultureInfo("tr-TR")

        ' Get the culture that is associated with the current thread. 
        Dim thisCulture As CultureInfo = Thread.CurrentThread.CurrentCulture

        ' Get the standard StringComparers. 
        Dim invCmp As StringComparer = StringComparer.InvariantCulture
        Dim invICCmp As StringComparer = StringComparer.InvariantCultureIgnoreCase
        Dim currCmp As StringComparer = StringComparer.CurrentCulture
        Dim currICCmp As StringComparer = StringComparer.CurrentCultureIgnoreCase
        Dim ordCmp As StringComparer = StringComparer.Ordinal
        Dim ordICCmp As StringComparer = StringComparer.OrdinalIgnoreCase

        ' Create a StringComparer that uses the Turkish culture and ignores case. 
        Dim turkICComp As StringComparer = StringComparer.Create(turkish, True)

        ' Define three strings consisting of different versions of the letter I. 
        ' LATIN CAPITAL LETTER I (U+0049) 
        Dim capitalLetterI As String = "I" 

        ' LATIN SMALL LETTER I (U+0069) 
        Dim smallLetterI As String = "i" 

        Dim smallLetterDotlessI As String = "ı" 

        ' Add the three strings to the list.

        ' Display the original list order.
        Display(list, "The original order of the list entries...")

        ' Sort the list using the invariant culture.
        Display(list, "Invariant culture...")
        Display(list, "Invariant culture, ignore case...")

        ' Sort the list using the current culture.
        Console.WriteLine("The current culture is ""{0}"".", thisCulture.Name)
        Display(list, "Current culture...")
        Display(list, "Current culture, ignore case...")

        ' Sort the list using the ordinal value of the character code points.
        Display(list, "Ordinal...")
        Display(list, "Ordinal, ignore case...")

        ' Sort the list using the Turkish culture, which treats LATIN SMALL LETTER  
        ' DOTLESS I differently than LATIN SMALL LETTER I.
        Display(list, "Turkish culture, ignore case...")

    End Sub 'Main

    Public Shared Sub Display(ByVal lst As List(Of String), ByVal title As String)
        Dim c As Char 
        Dim s As String 
        Dim codePoint As Integer

        For Each s In lst
            c = s(0)
            codePoint = Convert.ToInt32(c)
            Console.WriteLine("0x{0:x}", codePoint)
        Next s
    End Sub 'Display
End Class 'Sample '

'This code example produces the following results: 

'The original order of the list entries... 

'Invariant culture... 

'Invariant culture, ignore case... 

'The current culture is "en-US". 
'Current culture... 

'Current culture, ignore case... 


'Ordinal, ignore case... 

'Turkish culture, ignore case... 

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




May 2010

Added usage guidelines.

Customer feedback.