User Guide

616 Chapter 3: ColdFusion Functions

GetLocale

Description

Gets the current ColdFusion MX geographic/language locale value.

To set the default display format of date, time, number, and currency values in a ColdFusion

application session, you use the

SetLocale function.

Returns

The current locale value, as an English string. If a locale has a Java name and a name that

ColdFusion MX used prior to the ColdFusion MX 7 release (for example, en_US and English

(US)), ColdFusion MX returns the ColdFusion name (for example, English (US)).

See also

GetLocaleDisplayName

, SetLocale

History

ColdFusion MX 7: Added support for all Java locales and locale names.

ColdFusion MX: Changed behavior to that described in usage.

Usage

This function returns the locale name as it is represented in ColdFusion MX; for example,

Portuguese (Brazilian), or ca_ES. To get a locale name in the language of the locale, use the

GetLocaleDisplayName function, which returns português (Brasil) and català (Espanya).

This function determines whether a locale value is set for ColdFusion MX. (The value is set with

the

SetLocale function.)

• If the ColdFusion MX locale value is present, the function returns it.

• If the ColdFusion MX locale has not been explicitly set, ColdFusion now determines whether

the default locale of the ColdFusion server computer operating system is among the locale

values it supports. (The default locale is stored in the user environment variables user.language

and user.region.)

If the default locale value is not supported, the function returns English (US). ColdFusion sets

the locale in the JVM to this value; it persists until the server is restarted or it is reset with the

SetLocale function.

This function does not access a web browser’s Accept-Language HTTP header setting.

Note: When ColdFusion is started, it stores the supported locale values in the variable

Server.ColdFusion.SupportedLocales. ColdFusion MX supports the locales supported by its Java

runtime environment. The SupportedLocales value lists the Java names for the supported locales

and the corresponding names that ColdFusion MX used prior to the ColdFusion MX 7 release.