Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Translates virtual-key messages into character messages. The character messages are posted to the calling thread's message queue, to be read the next time the thread calls the GetMessage or PeekMessage function.
Syntax
WINUSERAPI
BOOL
WINAPI
TranslateMessageEx(
_In_ CONST MSG *lpMsg,
_In_ UINT flags);
Parameters
lpMsg [in]
A pointer to a MSG structure that contains message information retrieved from the calling thread's message queue by using the GetMessage or PeekMessage function.
flags [in]
The behavior of the function.
If bit 0 is set, a menu is active. In this mode Alt+Numeric keypad key combinations are not handled.
If bit 1 is set, TranslateMessageEx will return FALSE when it does not post WM_CHAR or WM_SYSCHAR to the message loop.
If bit 2 is set, keyboard state is not changed (Windows 10, version 1607 and newer)
All other bits (through 31) are reserved.
Return value
Returns a boolean value. If the message is translated (that is, a character message is posted to the thread's message queue), the return value is nonzero.
Unlike TranslateMessage, TranslateMessageEx will return FALSE for the case where it doesn't post a WM_CHAR.
If the message is not translated (that is, a character message is not posted to the thread's message queue), the return value is zero.
-remarks
The TranslateMessage function does not modify the message pointed to by the lpMsg parameter.
WM_KEYDOWN and WM_KEYUP combinations produce a WM_CHAR or WM_DEADCHAR message. WM_SYSKEYDOWN and WM_SYSKEYUP combinations produce a WM_SYSCHAR or WM_SYSDEADCHAR message.
TranslateMessage produces WM_CHAR messages only for keys that are mapped to ASCII characters by the keyboard driver.
If applications process virtual-key messages for some other purpose, they should not call TranslateMessage. For instance, an application should not call TranslateMessage if the TranslateAccelerator function returns a nonzero value. Note that the application is responsible for retrieving and dispatching input messages to the dialog box. Most applications use the main message loop for this. However, to permit the user to move to and to select controls by using the keyboard, the application must call IsDialogMessage. For more information, see Dialog Box Keyboard Interface.
This function is not defined in an SDK header and must be declared by the caller. This function is exported from user32.dll.