SetLocale

Sets the locale to the specified new locale for the current session.

Note: SetLocale returns the old locale in case it needs to be restored.

See also GetLocale.

Syntax

SetLocale(new_locale)
new_locale

The name of the locale you want to set.

Locale support

ColdFusion can be expected to support the following locales in a default Windows NT installation:

Locales Supported by ColdFusion
Dutch (Belgian) French (Canadian) Norwegian (Bokmal)
Dutch (Standard) French (Standard) Norwegian (Nynorsk)
English (Australian) French (Swiss) Portuguese (Brazilian)
English (Canadian) German (Austrian) Portuguese (Standard)
English (New Zealand) German (Standard) Spanish (Mexican)
English (UK) German (Swiss) Spanish (Modern)
English (US) Italian (Standard) Spanish (Standard)
French (Belgian) Italian (Swiss) Swedish

Note:

The variable Server.ColdFusion.SupportedLocales is initialized at startup with a comma-delimited list of the locales that ColdFusion and the operating system support. GetLocale( ) will return an entry from that list. SetLocale will fail if called with a locale name not on that list.

Example

<!--- This example shows SetLocale --->
<HTML>
<HEAD>
<TITLE>SetLocale Example</TITLE>
</HEAD>

<BODY>
<H3>SetLocale Example</H3>

<P>SetLocale sets the locale to the specified new locale
for the current session.

<P>A locale is an encapsulation of the set of attributes
that govern the display and formatting of international
date, time, number, and currency values.

<P>The locale for this system is <CFOUTPUT>#GetLocale()#</CFOUTPUT>

<P><CFOUTPUT><I>the old locale was #SetLocale("English (UK)")#</I>
<P>The locale is now #GetLocale()#</CFOUTPUT>

</BODY>
</HTML>