LCIDToLocaleName function (winnls.h)

Converts a locale identifier to a locale name.

Note  For custom locales, including those created by Microsoft, your applications should prefer locale names over locale identifiers.

 

Syntax

int LCIDToLocaleName(
  [in]            LCID   Locale,
  [out, optional] LPWSTR lpName,
  [in]            int    cchName,
  [in]            DWORD  dwFlags
);

Parameters

[in] Locale

Locale identifier to translate. You can use the MAKELCID macro to create a locale identifier or use one of the following predefined values.

• LOCALE_INVARIANT
• LOCALE_SYSTEM_DEFAULT
• LOCALE_USER_DEFAULT

Windows Vista: The following custom locale identifiers are also supported.

• LOCALE_CUSTOM_DEFAULT
• LOCALE_CUSTOM_UI_DEFAULT
• LOCALE_CUSTOM_UNSPECIFIED

[out, optional] lpName

Pointer to a buffer in which this function retrieves the locale name, or one of the following predefined values.

• LOCALE_NAME_INVARIANT
• LOCALE_NAME_SYSTEM_DEFAULT
• LOCALE_NAME_USER_DEFAULT

[in] cchName

Size, in characters, of the locale name buffer. The maximum possible length of a locale name, including a terminating null character, is LOCALE_NAME_MAX_LENGTH. This is the recommended size to supply for this parameter.

Alternatively, the application can set this parameter to 0. In this case, the function returns the required size for the locale name buffer.

[in] dwFlags

Before Windows 7: Reserved; should always be 0.

Starting with Windows 7: Can be set to LOCALE_ALLOW_NEUTRAL_NAMES to allow the return of a neutral name.

Return value

Returns the count of characters, including the terminating null character, in the locale name if successful. If the function succeeds and the value of cchName is 0, the return value is the required size, in characters (including nulls), for the locale name buffer.

The function returns 0 if it does not succeed. To get extended error information, the application can call GetLastError, which can return one of the following error codes:

• ERROR_INSUFFICIENT_BUFFER. A supplied buffer size was not large enough, or it was incorrectly set to NULL.
• ERROR_INVALID_PARAMETER. Any of the parameter values was invalid.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps | UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps | UWP apps]
Target Platform	Windows
Header	winnls.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll

See also

LocaleNameToLCID

National Language Support

National Language Support Functions