ActivateKeyboardLayout

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function sets the input locale identifier, formerly called the keyboard layout handle, for the system. The input locale identifier specifies a locale as well as the physical layout of the keyboard.

Syntax

HKL ActivateKeyboardLayout(
  HKL hkl,
  UINT Flags
);

Parameters

• hkl
  [in] Input locale identifier to be activated. Obtain this parameter with LoadKeyboardLayout or GetKeyboardLayoutList.

• Flags
  [in] Ignored.

Return Value

The return value is of type HKL. If the function succeeds, the return value is the previous input locale identifier. Otherwise, it is zero.

To obtain extended error information, call the GetLastError function.

Remarks

This function is not restricted to keyboard layouts. The hkl parameter is actually an input locale identifier, because it can also encompass a speech-to-text converter, an IME, or any other form of input. Several input locale identifiers can be loaded at any one time, but only one is active at a time.

Requirements

See Also

Reference

GetKeyboardLayoutList
LoadKeyboardLayout

Other Resources

Keyboard Drivers
Layout Manager