User Guide

SetLocale 835

SetLocale

Description

Sets the country/language locale for ColdFusion processing and the page returned to the client.

The locale value determines the default format of date, time, number, and currency values,

according to language and regional conventions.

Returns

The locale value prior to setting the new locale, as a string.

See also

GetHttpTimeString

, GetLocale, GetLocaleDisplayName; “Locales” in Chapter 17,

“Developing Globalized Applications” in ColdFusion MX Developer’s Guide

History

ColdFusion MX 7: Added support for all locales supported by the ColdFusion MX Java runtime.

ColdFusion MX:

• Changed formatting behavior: this function might return a different value than in earlier

releases. This function uses Java standard locale determination and formatting rules on all

platforms.

• Deprecated the Spanish (Mexican) locale option. It might not work, and it might cause an

error, in later releases.

• Changed the Spanish (Modern) option: it now sets the locale to Spanish (Standard).

Parameters

Usage

You can specify any locale name that is listed in the Server.Coldfusion.SupportedLocales variable.

This variable is a comma-delimited list of all locale names supported by the JVM, plus the locale

names that were required by ColdFusion MX prior to ColdFusion MX 7.

The following locale names were used in ColdFusion releases through ColdFusion MX 6.1, and

continue to be supported. If you use any of these values in the

SetLocale function, the

GetLocale function returns the name you set, not the corresponding Java locale name.

Parameter Description

new_locale The name of a locale; for example, "English (US)"

Chinese (China) French (Belgian) Korean

Chinese (Hong Kong) French (Canadian) Norwegian (Bokmal)