Export (0) Print
Expand All

CultureInfo.GetCultureInfo Method (String)

Retrieves a cached, read-only instance of a culture using the specified culture name.

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

static member GetCultureInfo : 
        name:string -> CultureInfo

Parameters

name
Type: System.String

The name of a culture. name is not case-sensitive.

Return Value

Type: System.Globalization.CultureInfo
A read-only CultureInfo object.

ExceptionCondition
ArgumentNullException

name is null.

CultureNotFoundException

name specifies a culture that is not supported.

For a list of predefined culture names, see the National Language Support (NLS) API Reference at the Go Global Developer Center.

The GetCultureInfo method retrieves a cached, read-only CultureInfo object. It offers better performance than a corresponding call to the CultureInfo.CultureInfo(String) constructor.

If name is the name of the current culture, the returned CultureInfo object does not reflect any user overrides. This makes the method suitable for server applications or tools that do not have a real user account on the system and that need to load multiple cultures efficiently.

If name is String.Empty, the method returns the invariant culture. This is equivalent to retrieving the value of the InvariantCulture property.

Notes to Callers

The .NET Framework 3.5 and earlier versions throw an ArgumentException if name is not a valid culture name. Starting with the .NET Framework 4, this method throws a CultureNotFoundException.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Show:
© 2014 Microsoft