Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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

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