User Guide

496 Chapter 3: ColdFusion Functions

GetLocale

Description

Gets the current 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 a string.

See also

SetLocale

History

ColdFusion MX: Changed behavior: this function determines whether a locale value is set. (The

value is set with the

SetLocale function.)

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

• If the 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 supported, the function returns this value

■ If the default locale value is not supported, the function returns English (US). (The code is

en_us"). (When ColdFusion is started, it stores the supported locale values in the variable

Server.ColdFusion.SupportedLocales.) 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.

Usage

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

Example

<h3>GetLocale Example</h3>

<p>The locale for this system is <cfoutput>#GetLocale()#</cfoutput>