Функция GetSystemDefaultLocaleName (winnls.h)

Статья
03/04/2024

Получает имя системного языкового стандарта по умолчанию.

Примечание Рекомендуется, чтобы приложения вызывали GetUserDefaultLocaleName в приоритете над этой функцией. Это связано с тем, что языковой стандарт пользователя обычно является более полезным и точным для пользователя, чем языковой стандарт системы.

Примечание Приложение должно вызывать эту функцию в предпочтительном режиме getSystemDefaultLCID , если оно предназначено для работы только в Windows Vista и более поздних версиях.

Синтаксис

int GetSystemDefaultLocaleName(
  [out] LPWSTR lpLocaleName,
  [in]  int    cchLocaleName
);

Параметры

[out] lpLocaleName

Указатель на буфер, в котором эта функция получает имя языкового стандарта.

[in] cchLocaleName

Размер выходного буфера в символах, указанный lpLocaleName. Максимально возможная длина символа имени языкового стандарта (включая завершающий символ NULL) — это значение LOCALE_NAME_MAX_LENGTH. Это рекомендуемый размер.

Возвращаемое значение

Возвращает значение больше 0, указывающее длину имени языкового стандарта, включая завершающий символ NULL, в случае успешного выполнения.

Эта функция возвращает значение 0, если не удалось. Чтобы получить расширенные сведения об ошибке, приложение может вызвать Метод GetLastError, который может возвращать один из следующих кодов ошибок:

ERROR_INSUFFICIENT_BUFFER. Указанный размер буфера был недостаточно велик или неправильно задано значение NULL.

Эта функция может получать данные из пользовательских языковых стандартов. Данные не всегда будут одинаковыми на разных компьютерах или между запусками приложения. Если приложение должно сохранять или передавать данные, см. статью Использование данных сохраняемого языкового стандарта.

Примеры

Пример использования этой функции можно найти в разделе Пример API на основе имен NLS.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2008 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	winnls.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll