ImmGetVirtualKey (Compact 2013)

3/28/2014

This function returns the original virtual key value that was recently processed by an input method editor (IME) on a specified input context.

Syntax

UINT ImmGetVirtualKey( 
  HWND hWnd
);

Parameters

  • hWnd
    [in] Handle to the window that receives the key message. The input context that is queried is the one associated with this window.

Return Value

This function returns the original virtual key value to indicate success. It returns 0 when no virtual key has been processed by the IME on the specified input context.

Remarks

Although the IMM sets the virtual key value to VK_PROCESSKEY when the IME processes a given virtual key, an application can recover the original virtual key value with the ImmGetVirtualKey function. This function is only used for key input messages containing the VK_PROCESSKEY value. Applications can get the original virtual key by using ImmGetVirtualKey after they receive the WM_KEYDOWN (VK_PROCESSKEY) message.

Requirements

Header

imm.h

Library

Coreimm.lib

See Also

Reference

Input Method Manager (IMM) Functions