Функция GetKeyboardLayoutNameW (winuser.h)

Статья
03/13/2024

Извлекает имя идентификатора активного входного языкового стандарта (прежнее название — раскладка клавиатуры) для вызывающего потока.

Синтаксис

BOOL GetKeyboardLayoutNameW(
  [out] LPWSTR pwszKLID
);

Параметры

[out] pwszKLID

Тип: LPTSTR

Буфер (длиной не менее KL_NAMELENGTH символов), который получает имя идентификатора входного языкового стандарта, включая завершающий символ NULL. Это будет копия строки, предоставленной функции LoadKeyboardLayout , если не произошла подстановка макета.

Список макетов ввода, которые предоставляются вместе с Windows, см. в разделе Идентификаторы клавиатуры и редакторы методов ввода для Windows.

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

Тип: BOOL

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Идентификатор языкового стандарта ввода является более широким понятием, чем раскладка клавиатуры, так как он также может охватывать преобразователь речи в текст, метод ввода Редактор (IME) или любую другую форму ввода.

Начиная с Windows 8. Предпочтительным методом получения языка, связанного с текущей раскладкой клавиатуры или методом ввода, является вызов Windows.Globalization.Language.CurrentInputMethodLanguageTag. Если приложение передает языковые теги из CurrentInputMethodLanguageTag в какие-либо функции поддержки национальных языков , оно должно сначала преобразовать теги, вызвав ResolveLocaleName.

Примечание

Заголовок winuser.h определяет GetKeyboardLayoutName в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winuser.h (включая Windows.h)
Библиотека	User32.lib
DLL	User32.dll