ImmSetHotKey

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function is called by the IME control panel application to set the value of the input method editor (IME) hot key.

Syntax

BOOL WINAPI ImmSetHotKey( 
  DWORD dwHotKeyID,
  UINT uModifiers,
  UINT uVKey,
  HKL hKL
);
        

Parameters

• dwHotKeyID
  [in] Hot key identifier.

• uModifiers
  [in] Pointer to the combination keys used with the hot key. Keys include MOD_ALT, MOD_CONTROL, MOD_SHIFT, MOD_LEFT, and MOD_RIGHT. The key up flag, MOD_ON_KEYUP, indicates the hot key is effective when the key is up. The modifier ignore flag, MOD_IGNORE_ALL_MODIFIER, indicates the combination of modifiers are ignored in hot key matching.

• uVKey
  [in] Virtual key code of the hot key.

• hKL
  [in] Handle to the keyboard layout of the IME. If this parameter is specified, the hot key can switch to the IME with this keyboard layout handle.

  Windows Embedded CE does not support true keyboard layouts. In this instance, however, Windows Embedded CE uses the keyboard handle to associate hot keys with a specific IME and locale.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

For a key that is not on each side of the keyboard, uModifiers should specify both sides, MOD_LEFT|MODE_RIGHT.

The following table shows the hot key identifiers that are supported by Windows Embedded CE.

Requirements