VkKeyScanEx function

Translates a character to the corresponding virtual-key code and shift state. The function translates the character using the input language and physical keyboard layout identified by the input locale identifier.

Syntax


SHORT WINAPI VkKeyScanEx(
  _In_  TCHAR ch,
  _In_  HKL dwhkl
);

Parameters

ch [in]

Type: TCHAR

The character to be translated into a virtual-key code.

dwhkl [in]

Type: HKL

Input locale identifier used to translate the character. This parameter can be any input locale identifier previously returned by the LoadKeyboardLayout function.

Return value

Type: SHORT

If the function succeeds, the low-order byte of the return value contains the virtual-key code and the high-order byte contains the shift state, which can be a combination of the following flag bits.

Return valueDescription
1

Either SHIFT key is pressed.

2

Either CTRL key is pressed.

4

Either ALT key is pressed.

8

The Hankaku key is pressed

16

Reserved (defined by the keyboard layout driver).

32

Reserved (defined by the keyboard layout driver).

 

If the function finds no key that translates to the passed character code, both the low-order and high-order bytes contain –1.

Remarks

The input locale identifier is a broader concept than a keyboard layout, since it can also encompass a speech-to-text converter, an Input Method Editor (IME), or any other form of input.

For keyboard layouts that use the right-hand ALT key as a shift key (for example, the French keyboard layout), the shift state is represented by the value 6, because the right-hand ALT key is converted internally into CTRL+ALT.

Translations for the numeric keypad (VK_NUMPAD0 through VK_DIVIDE) are ignored. This function is intended to translate characters into keystrokes from the main keyboard section only. For example, the character "7" is translated into VK_7, not VK_NUMPAD7.

VkKeyScanEx is used by applications that send characters by using the WM_KEYUP and WM_KEYDOWN messages.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

Unicode and ANSI names

VkKeyScanExW (Unicode) and VkKeyScanExA (ANSI)

See also

Reference
GetAsyncKeyState
GetKeyboardState
GetKeyNameText
GetKeyState
LoadKeyboardLayout
SetKeyboardState
ToAsciiEx
Conceptual
Keyboard Input

 

 

Community Additions

ADD
Show:
© 2014 Microsoft