LCIDToLocaleName

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(
         LCID Locale,
         _Out_writes_opt_(cchName)LPWSTR lpName,
         int cchName,
         DWORD dwFlags
)  

Parameters

Locale
Type: LCID 

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

lpName
Type: Out_writes_opt(cchName)LPWSTR 

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

cchName
Type: int 

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.

dwFlags
Type: DWORD 

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

Type: int 

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.

Remarks

Windows Phone 8: This API is supported.

Requirements

Header: Declared in winnls.h.

Library: Use kernelx.lib.