IMC_GETCANDIDATEPOS

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This message is sent by an application to an IME window to get the position of the candidate window. Because the IME may adjust the candidate window position, an application uses this message to get the actual position to decide whether to reposition the window.

Syntax

WM_IME_CONTROL
  wSubMessage = IMC_GETCANDIDATEPOS;
  lpCANDIDATENFORM = (lpCANDIDATEFORM) lParam;

Parameters

• lpCANDIDATENFORM
  Buffer to retrieve the position of the candidate window.

Return Value

If the message is successful, the return value is zero. Otherwise, the return value is nonzero.

Remarks

In return, the IME will fill the CANDIDATEFORM structure pointed to by lpCANDIDATENFORM with the client coordinates of the application's focus window. The UI window receives this message. An application should specify lpCANIDATEFORM->dwIndex to zero ~ 3 to obtain a different candidate window position. (For example, index zero is a top-level candidate window.)

Requirements

See Also

Reference

CANDIDATEFORM