EM_GETIMECOMPTEXT Message

An application sends an EM_GETIMECOMPTEXT message to get the Input Method Editor (IME) composition text.

Syntax

To send this message, call the SendMessage function as follows.


lResult = SendMessage(
    // returns LONG in lResult
   (HWND) hWndControl,
    // handle to destination control
   (UINT) EM_GETIMECOMPTEXT,
    // message ID
   (WPARAM) wParam,
    // = (WPARAM) (IMECOMPTEXT*) wParam;
   (LPARAM) lParam
    // = (LPARAM) (BYTE*) lParam;

);

Parameters

wParam
Pointer to the IMECOMPTEXT structure.
lParam
Pointer to the buffer that receives the composition text. The size of this buffer is contained in the cb.

Return Value

If successful, the return value is the number of Unicode characters copied to the buffer. Otherwise, it is zero.

Remarks

This message only takes Unicode strings.
Security Alert Be sure to have a buffer sufficient for the size of the input. Failure to do so could cause problems for your application.

Message Information

Minimum DLL Version msftedit.dll
Header Declared in Richedit.h
Minimum operating systems Windows XP SP1