Edit

IMC_GETCANDIDATEPOS command

  • Article

Instructs an IME window to get the position of the candidate window. To send this command, the application uses the WM_IME_CONTROL message with the parameter settings shown below.

LRESULT IMC_GETCANDIDATEPOS

Parameters

wParam

Set to IMC_GETCANDIDATEPOS.

lParam

Pointer to a CANDIDATEFORM structure that contains the position of the candidate window.

Return Value

Returns 0 if successful, or a nonzero value otherwise.

Remarks

Because the IME might adjust the position of a candidate window, an application uses this command to get the actual position to decide whether to reposition the window. The retrieved position is in window coordinates relative to the window having the current input focus.

Requirements

Requirement Value
Minimum supported client
 Windows 2000 Professional [desktop apps only]
Minimum supported server
 Windows 2000 Server [desktop apps only]
Header
Imm.h (include Windows.h)

See also

Input Method Manager

Input Method Manager Commands

CANDIDATEFORM