GetKeyboardLayoutName

The GetKeyboardLayoutName function retrieves the name of the active keyboard layout.

BOOL GetKeyboardLayoutName(
  LPTSTR pwszKLID   // pointer to buffer for layout name
);
 

Parameters

pwszKLID

Pointer to the buffer of at least KL_NAMELENGTH characters that is to receive the name of the keyboard layout, including the NULL terminator. This will be a copy of the string provided to the LoadKeyboardLayout function, unless layout substitution took place.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Windows NT: GetKeyboardLayoutName receives the name of the active keyboard layout for the system.

Windows 95: GetKeyboardLayoutName receives the name of the active keyboard layout for the calling thread.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winuser.h.
  Import Library: Use user32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Keyboard Input Overview, Keyboard Input Functions, ActivateKeyboardLayout, LoadKeyboardLayout, UnloadKeyboardLayout