Changes the current locale of the script instance.

All script instances operate within the context of a locale, as specified in mceadmin for the executing application partition of the application. ChangeLocale allows a developer to programmatically change this starting locale after the script instance has begun executing.

By changing the locale of the script and setting ResetStrings to true, global variables initialized by localizable strings defined in the locale table will update their values to reflect the string values corresponding to the new locale. Also, if using the Prompt fields in Play or VoiceRecognition to specify audio files, the audio file that correlates to the new locale will be played instead after the change. If there is no value specified in the Localization Editor in the Application Designer for a particular locale of a string, then the global variable that initializes from that localized string will have an empty string value after the ChangeLocale action completes (and if ResetStrings is set to true). If an audio file does not exist for the current locale, the Play command will play nothing and will complete immediately.

If global variables are initialized with strings from the locale table, one must set ResetStrings to true in order to have those global variables update their values when the ChangeLocale action is used.

The sessionData object has a System.Globalization.CultureInfo Culture property. It represents the current locale of the script, and is updated accordingly by ChangeLocale.

The list of valid locales for the Locale action parameter are the set of locales returned by the System.Globalization.CultureTypes.SpecificCultures array. Valid values for Locale are shown for convenience in the Locale Name column in the following table:

Locale Name	Friendly Name
af-ZA	Afrikaans (South Africa)
ar-AE	Arabic (U.A.E.)
ar-BH	Arabic (Bahrain)
ar-DZ	Arabic (Algeria)
ar-EG	Arabic (Egypt)
ar-IQ	Arabic (Iraq)
ar-JO	Arabic (Jordan)
ar-KW	Arabic (Kuwait)
ar-LB	Arabic (Lebanon)
ar-LY	Arabic (Libya)
ar-MA	Arabic (Morocco)
ar-OM	Arabic (Oman)
ar-QA	Arabic (Qatar)
ar-SA	Arabic (Saudi Arabia)
ar-SY	Arabic (Syria)
ar-TN	Arabic (Tunisia)
ar-YE	Arabic (Yemen)
az-AZ-Cyrl	Azeri (Cyrillic, Azerbaijan)
az-AZ-Latn	Azeri (Latin, Azerbaijan)
be-BY	Belarusian (Belarus)
bg-BG	Bulgarian (Bulgaria)
bs-BA-Latn	Bosnian (Bosnia and Herzegovina)
ca-ES	Catalan (Catalan)
cs-CZ	Czech (Czech Republic)
cy-GB	Welsh (United Kingdom)
da-DK	Danish (Denmark)
de-AT	German (Austria)
de-CH	German (Switzerland)
de-DE	German (Germany)
de-LI	German (Liechtenstein)
de-LU	German (Luxembourg)
div-MV	Divehi (Maldives)
el-GR	Greek (Greece)
en-AU	English (Australia)
en-BZ	English (Belize)
en-CA	English (Canada)
en-CB	English (Caribbean)
en-GB	English (United Kingdom)
en-IE	English (Ireland)
en-JM	English (Jamaica)
en-NZ	English (New Zealand)
en-PH	English (Republic of the Philippines)
en-TT	English (Trinidad and Tobago)
en-US	English (United States)
en-ZA	English (South Africa)
en-ZW	English (Zimbabwe)
es-AR	Spanish (Argentina)
es-BO	Spanish (Bolivia)
es-CL	Spanish (Chile)
es-CO	Spanish (Colombia)
es-CR	Spanish (Costa Rica)
es-DO	Spanish (Dominican Republic)
es-EC	Spanish (Ecuador)
es-ES	Spanish (Spain)
es-GT	Spanish (Guatemala)
es-HN	Spanish (Honduras)
es-MX	Spanish (Mexico)
es-NI	Spanish (Nicaragua)
es-PA	Spanish (Panama)
es-PE	Spanish (Peru)
es-PR	Spanish (Puerto Rico)
es-PY	Spanish (Paraguay)
es-SV	Spanish (El Salvador)
es-UY	Spanish (Uruguay)
es-VE	Spanish (Venezuela)
et-EE	Estonian (Estonia)
eu-ES	Basque (Basque)
fa-IR	Persian (Iran)
fi-FI	Finnish (Finland)
fo-FO	Faroese (Faroe Islands)
fr-BE	French (Belgium)
fr-CA	French (Canada)
fr-CH	French (Switzerland)
fr-FR	French (France)
fr-LU	French (Luxembourg)
fr-MC	French (Principality of Monaco)
gl-ES	Galician (Galician)
gu-IN	Gujarati (India)
he-IL	Hebrew (Israel)
hi-IN	Hindi (India)
hr-BA	Croatian (Bosnia and Herzegovina)
hr-HR	Croatian (Croatia)
hu-HU	Hungarian (Hungary)
hy-AM	Armenian (Armenia)
id-ID	Indonesian (Indonesia)
is-IS	Icelandic (Iceland)
it-CH	Italian (Switzerland)
it-IT	Italian (Italy)
ja-JP	Japanese (Japan)
ka-GE	Georgian (Georgia)
kk-KZ	Kazakh (Kazakhstan)
kn-IN	Kannada (India)
kok-IN	Konkani (India)
ko-KR	Korean (Korea)
ky-KG	Kyrgyz (Kyrgyzstan)
lt-LT	Lithuanian (Lithuania)
lv-LV	Latvian (Latvia)
mi-NZ	Maori (New Zealand)
mk-MK	Macedonian (Former Yugoslav Republic of Macedonia)
mn-MN	Mongolian (Cyrillic, Mongolia)
mr-IN	Marathi (India)
ms-BN	Malay (Brunei Darussalam)
ms-MY	Malay (Malaysia)
mt-MT	Maltese (Malta)
nb-NO	Norwegian, Bokm†l (Norway)
nl-BE	Dutch (Belgium)
nl-NL	Dutch (Netherlands)
nn-NO	Norwegian, Nynorsk (Norway)
ns-ZA	Northern Sotho (South Africa)
pa-IN	Punjabi (India)
pl-PL	Polish (Poland)
pt-BR	Portuguese (Brazil)
pt-PT	Portuguese (Portugal)
quz-BO	Quechua (Bolivia)
quz-EC	Quechua (Ecuador)
quz-PE	Quechua (Peru)
ro-RO	Romanian (Romania)
ru-RU	Russian (Russia)
sa-IN	Sanskrit (India)
se-FI	Sami (Northern) (Finland)
se-NO	Sami (Northern) (Norway)
se-SE	Sami (Northern) (Sweden)
sk-SK	Slovak (Slovakia)
sl-SI	Slovenian (Slovenia)
sma-NO	Sami (Southern) (Norway)
sma-SE	Sami (Southern) (Sweden)
smj-NO	Sami (Lule) (Norway)
smj-SE	Sami (Lule) (Sweden)
smn-FI	Sami (Inari) (Finland)
sms-FI	Sami (Skolt) (Finland)
sq-AL	Albanian (Albania)
sr-BA-Cyrl	Serbian (Cyrillic) (Bosnia and Herzegovina)
sr-BA-Latn	Serbian (Latin) (Bosnia and Herzegovina)
sr-SP-Cyrl	Serbian (Cyrillic, Serbia and Montenegro)
sr-SP-Latn	Serbian (Latin, Serbia and Montenegro)
sv-FI	Swedish (Finland)
sv-SE	Swedish (Sweden)
sw-KE	Kiswahili (Kenya)
syr-SY	Syriac (Syria)
ta-IN	Tamil (India)
te-IN	Telugu (India)
th-TH	Thai (Thailand)
tn-ZA	Tswana (South Africa)
tr-TR	Turkish (Turkey)
tt-RU	Tatar (Russia)
uk-UA	Ukrainian (Ukraine)
ur-PK	Urdu (Islamic Republic of Pakistan)
uz-UZ-Cyrl	Uzbek (Cyrillic, Uzbekistan)
uz-UZ-Latn	Uzbek (Latin, Uzbekistan)
vi-VN	Vietnamese (Vietnam)
xh-ZA	Xhosa (South Africa)
zh-CN	Chinese (People's Republic of China)
zh-HK	Chinese (Hong Kong S.A.R.)
zh-MO	Chinese (Macao S.A.R.)
zh-SG	Chinese (Singapore)
zh-TW	Chinese (Taiwan)
zu-ZA	Zulu (South Africa)