ResolveLocaleName function

Finds a possible locale name match for the supplied name.

Syntax

int ResolveLocaleName(
  LPCWSTR lpNameToResolve,
  LPWSTR  lpLocaleName,
  int     cchLocaleName
);

Parameters

lpNameToResolve

Pointer to a name to resolve, for example, "en-FJ" for English (Fiji).

lpLocaleName

Pointer to a buffer in which this function retrieves the locale name that is the match for the input name. For example, the match for the name "en-FJ" is "en-US" for English (United States).

Note  If the function fails, the state of the output buffer is not guaranteed to be accurate. In this case, the application should check the return value and error status set by the function to determine the correct course of action.
 

cchLocaleName

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

Return Value

Returns the size of the buffer containing the locale name, including the terminating null character, if successful.

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.

Remarks

The retrieved locale name indicates a specific locale, including language and country/region, even if the input language is neutral. For example, an input of "en" for English (United States) causes the function to retrieve "en-US".

This function can retrieve data from custom locales. Data is not guaranteed to be the same from computer to computer or between runs of an application, nor does the return of a valid locale guarantee that it will be valid on another computer. If your application must persist or transmit data, see Using Persistent Locale Data.

Beginning in Windows 8: Language tags obtained from the Windows.Globalization namespace must be converted by ResolveLocaleName before they can be used with any National Language Support functions.

Requirements

   
Windows version Windows 7 [desktop apps | UWP apps] Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header winnls.h (include Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See Also

National Language Support

National Language Support Functions

Windows.Globalization