ImmGetHotKey

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the value of the input method editor (IME) hot key.

Syntax

BOOL WINAPI ImmGetHotKey( 
  DWORD dwHotKeyID,
  LPUINT lpuModifiers,
  LPUINT lpuVKey,
  LPHKL lphKL
);

Parameters

• dwHotKeyID
  [in] Hot key identifier.

• lpuModifiers
  [out] Long 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.

• lpuVKey
  [out] Long pointer to the virtual key code of the hot key.

• lphKL
  [out] Long pointer to the handle to the keyboard layout of the IME. If the return value of this parameter is NULL, 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 returns the keyboard handle that is associated with the current IME and locale.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

This function is called by the IME control panel application.

Requirements