RegionInfo Constructor (String)

Initializes a new instance of the RegionInfo class based on the country/region or specific culture, specified by name.

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

'Declaration
Public Sub New ( _
	name As String _
)

Parameters

name
Type: System.String

A string that contains a two-letter code defined in ISO 3166 for country/region.

-or-

A string that contains the culture name for a specific culture, custom culture, or Windows-only culture. If the culture name is not in RFC 4646 format, your application should specify the entire culture name instead of just the country/region.

ExceptionCondition
ArgumentNullException

name is Nothing.

ArgumentException

name is not a valid country/region name or specific culture name.

The name parameter is either one of the codes defined for country/region, or a specific, custom, or Windows-only culture name. Case is not significant. However, the Name, the TwoLetterISORegionName, and the ThreeLetterISORegionName properties return the specified code or culture name in uppercase.

The predefined RegionInfo names are listed in Country names and code elements on the ISO website.

You should provide the name of a specific culture rather than just a country/region name in the name parameter. For example, en-US for English (United States) or es-US for Spanish (United States) is preferable to US because properties such as NativeName and CurrencyNativeName reflect a specific language. az-Latn-AZ or az-Cyrl-AZ is preferable to AZ because properties such as NativeName, CurrencyNativeName, and CurrencySymbol reflect a specific script. The predefined culture names are listed in the National Language Support (NLS) API Reference at the Go Global Developer Center. Note that a call to this constructor throws an ArgumentException if name is a neutral culture (such as en for English).

Notes to Callers

This constructor accepts only specific cultures or country/region codes. However, some neutral culture names are the same as country/region codes. In this case, name is interpreted as a country/region code rather than a neutral culture name, and this constructor does not throw an ArgumentException.

The following code example compares two instances of RegionInfo that were created differently.

Imports System
Imports System.Globalization


Public Class SamplesRegionInfo   

   Public Shared Sub Main()

      ' Creates a RegionInfo using the ISO 3166 two-letter code. 
      Dim myRI1 As New RegionInfo("US")

      ' Creates a RegionInfo using a CultureInfo.LCID. 
      Dim myRI2 As New RegionInfo(New CultureInfo("en-US", False).LCID)

      ' Compares the two instances. 
      If myRI1.Equals(myRI2) Then
         Console.WriteLine("The two RegionInfo instances are equal.")
      Else
         Console.WriteLine("The two RegionInfo instances are NOT equal.")
      End If  

   End Sub 'Main

End Class 'SamplesRegionInfo 


'This code produces the following output. 



'The two RegionInfo instances are equal.

The following code example creates instances of RegionInfo using culture names.

Imports System
Imports System.Globalization

Public Class SamplesRegionInfo

    Public Shared Sub Main()

        ' Creates an array containing culture names. 
        Dim myCultures() As String = {"", "ar", "ar-DZ", "en", "en-US"}

        Dim culture As String 

        ' Creates a RegionInfo for each of the culture names. 
        '    Note that "ar" is the culture name for the neutral culture "Arabic", 
        '    but it is also the region name for the country/region "Argentina"; 
        '    therefore, it does not fail as expected.
        Console.WriteLine("Without checks...")
        For Each culture In  myCultures
            Try 
                Dim myRI As New RegionInfo(culture)
            Catch e As ArgumentException
                Console.WriteLine(e.ToString())
            End Try 
        Next

        Console.WriteLine()

        Console.WriteLine("Checking the culture names first...")
        For Each culture In  myCultures
            If culture = "" Then
                Console.WriteLine("The culture is the invariant culture.")
            Else 
                Dim myCI As New CultureInfo(culture, False)
                If myCI.IsNeutralCulture Then
                    Console.WriteLine("The culture {0} is a neutral culture.", culture)
                Else
                    Console.WriteLine("The culture {0} is a specific culture.", culture)
                    Try 
                        Dim myRI As New RegionInfo(culture)
                    Catch e As ArgumentException
                        Console.WriteLine(e.ToString())
                    End Try 
                End If 
            End If 
        Next 
    End Sub   
End Class  
'The example displays the following output. 

'Without checks... 
'System.ArgumentException: Region name '' is not supported. 
'Parameter name: name 
'   at System.Globalization.RegionInfo..ctor(String name) 
'   at SamplesRegionInfo.Main() 
'System.ArgumentException: Region name 'en' is not supported. 
'Parameter name: name 
'   at System.Globalization.CultureTableRecord..ctor(String regionName, Boolean useUserOverride) 
'   at System.Globalization.RegionInfo..ctor(String name) 
'   at SamplesRegionInfo.Main() 

'Checking the culture names first... 
'The culture is the invariant culture. 
'The culture ar is a neutral culture. 
'The culture ar-DZ is a specific culture. 
'The culture en is a neutral culture. 
'The culture en-US is a specific culture.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft