ConvertDefaultLocale

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function converts a special default locale value to an actual locale identifier.

Syntax

LCID ConvertDefaultLocale(
  LCID Locale
);

Parameters

• Locale
  [in] Default locale value that the function converts to a locale identifier (LCID). The following table shows the default locale values:

  Value	Description
  LOCALE_SYSTEM_DEFAULT	The system's default locale.
  LOCALE_USER_DEFAULT	The current user's default locale.
  LOCALE_NEUTRAL	The language-neutral default locale.
  Any sublanguage-neutral locale	A locale identifier constructed by calling MAKELCID with a primary language identifier, such as LANG_ENGLISH, and the SUBLANG_NEUTRAL secondary language identifier.

Return Value

The appropriate LCID indicates success. The Locale parameter indicates failure. The function fails when Locale is not one of the default locale values listed above.

Remarks

A call to ConvertDefaultLocale(LOCALE_SYSTEM_DEFAULT) is equivalent to a call to the GetSystemDefaultLCID function. A call to ConvertDefaultLocale (LOCALE_USER_DEFAULT) is equivalent to a call to the GetUserDefaultLCID function.

For more information, see National Language support (NLS) Locale Identifiers.

Requirements

See Also

Reference

MAKELCID
GetSystemDefaultLCID
GetUserDefaultLCID

Other Resources

LCID
National Language Support (NLS) Locale Identifiers