IMC_GETCANDIDATEPOS

An application sends the IMC_GETCANDIDATEPOS command to an IME window to get the position of the candidate window. Because the IME may adjust the position of a candidate window, an application uses this command to get the actual position to decide whether to reposition the window.

To send this command, use the WM_IME_CONTROL message with wParam and lParam set as follows.

Parameters

wParam

Set to IMC_GETCANDIDATEPOS.

lParam

Pointer to the CANDIDATEFORM structure that receives the position of the candidate window.

Return Values

If the function succeeds, it returns zero. On failure it returns a nonzero value.

Remarks

The returned position is in window coordinates relative to the window having the current input focus.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Imm.h.

See Also

Input Method Editor Overview, Input Method Editor Commands, CANDIDATEFORM