ImmIsUIMessageW function (immdev.h)

Checks for messages intended for the IME window and sends those messages to the window.

Syntax

BOOL ImmIsUIMessageW(
       HWND   unnamedParam1,
       UINT   unnamedParam2,
       WPARAM unnamedParam3,
       LPARAM unnamedParam4
);

Parameters

unnamedParam1

unnamedParam2

unnamedParam3

unnamedParam4

Return value

Returns a nonzero value if the message is processed by the IME window, or 0 otherwise.

Remarks

An application typically uses this function to display a composition string or candidate list specified by the IME. If hWndIME is NULL, the function determines if the message is a user interface message.

Windows Me/98: This function has only an ANSI version. To receive Unicode characters from a Unicode-based IME, the application should use ImmGetCompositionString.

Note

The immdev.h header defines ImmIsUIMessage as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only],East Asian language support installed.
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header immdev.h (include Immdev.h, Windows.h)
Library Imm32.lib
DLL Imm32.dll

See also

ImmGetCompositionString

Input Method Manager

Input Method Manager Functions