Expand Minimize

GetSystemDefaultLocaleName function

Retrieves the system default locale name.

Note  The application should call this function in preference to GetSystemDefaultLCID if designed to run only on Windows Vista and later.

Syntax


int GetSystemDefaultLocaleName(
  _Out_  LPWSTR lpLocaleName,
  _In_   int cchLocaleName
);

Parameters

lpLocaleName [out]

Pointer to a buffer in which this function retrieves the locale name.

cchLocaleName [in]

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

Return value

Returns a value greater than 0 that indicates the length of the locale name, including the terminating null character, if successful.

This 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

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. If your application must persist or transmit data, see Using Persistent Locale Data.

Examples

An example showing the use of this function can be found in NLS: Name-based APIs Sample.

Requirements

Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Winnls.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

National Language Support
National Language Support Functions
Mapping Locale Data
DownlevelLCIDToLocaleName
GetLocaleInfoEx
GetUserDefaultLocaleName

 

 

Community Additions

ADD
Show:
© 2014 Microsoft