ImmSetCandidateWindow

The ImmSetCandidateWindow function sets information about the candidate list window.

BOOL ImmSetCandidateWindow(
  HIMC hIMC,                   
  LPCANDIDATEFORM lpCandidate  
);
 

Parameters

hIMC

Handle to the input context.

lpCandidate

Pointer to the CANDIDATEFORM structure that contains information about the candidate window.

Return Values

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero.

Remarks

ImmSetCandidateWindow causes an IMN_SETCANDIDATEPOS message to be sent to the application.

Windows CE: For Japanese version 1.0 and later, the ImmSetCandidateWindow function allows an index range of 0 to 4 for the dwIndex member of the CANDIDATEFORM structure.

QuickInfo

  Windows NT: Requires version 4.0 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Requires version 2.0 or later (FE).
  Header: Declared in imm.h.
  Import Library: Use imm32.lib.

See Also

Input Method Editor Overview, Input Method Editor Functions, CANDIDATEFORM