ImmSetHotKey

A version of this page is also available for

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
);

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.

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.

TRUE indicates success. FALSE indicates failure.

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.

Hot Key Identifier	Description
IME_CHOTKEY_SHAPE_TOGGLE	For simplified Chinese, toggles the shape conversion mode of IME.
IME_CHOTKEY_SYMBOL_TOGGLE	For simplified Chinese, toggles the symbol conversion mode of IME. Symbol mode indicates that the user can input Chinese punctuation and symbols by mapping to the punctuation and symbols on the keyboard.
IME_JHOTKEY_CLOSE_OPEN	For Japanese, alternately opens and closes the IME.
IME_KHOTKEY_ENGLISH	Switches to from Korean to English.
IME_KHOTKEY_SHAPE_TOGGLE	For Korean, toggles the shape conversion mode of IME.
IME_KHOTKEY_HANJACONVERT	For Korean, switches to Hanja conversion.
IME_THOTKEY_SHAPE_TOGGLE	For traditional Chinese, toggles the shape conversion mode of IME.
IME_THOTKEY_SYMBOL_TOGGLE	For traditional Chinese, toggles the symbol conversion mode of IME.
IME_HOTKEY_DSWITCH_FIRST through IME_HOTKEY_DSWITCH_LAST	Enables an IME to be switched.

Header	imm.h
Library	Coreimm.lib
Windows Embedded CE	Windows CE .NET 4.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later