GetKeyboardLayoutName

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the name of the active keyboard layout.

Syntax

BOOL GetKeyboardLayoutName( 
  LPTSTR pwszKLID 
);

Parameters

• pwszKLID
  [in] Pointer to the buffer of at least KL_NAMELENGTH characters that is to receive the name of the keyboard layout, including the terminating null character.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

The layout name is read from the registry and not from the loaded keyboard layout. Windows Embedded CE does not support the LoadKeyboardLayout function or any other keyboard layout function. Therefore, to change the keyboard layout name, use an application, such as a Control Panel program, that changes the Active entry in the following registry subkey:

HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\KeyboardLayout

The value of the Active entry identifies the system keyboard layout. Its type is REG_SZ.

To use a newly specified keyboard layout, the user must reset the device.

Requirements

See Also

Reference

Keyboard Functions