CFML Reference
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.

Return value

The current locale value, as a string.

Category

Display and formatting functions, International functions, System functions

Syntax

GetLocale()

See also

SetLocale

History

New in ColdFusion MX: 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 returns it.
• If the locale has not been explicitly set, ColdFusion 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>

ColdFusion 9 | ColdFusion 8 | ColdFusion MX 7 | ColdFusion MX 6.1 | ColdFusion MX | Forums | Developer Center | Bug Reporting

Version 6

Comments are no longer accepted for ColdFusion MX. ColdFusion 8 is the current version.

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/coldfusion/6/CFML_Reference/functions-pt1100.htm

Add Comment