ImmGetCandidateWindow

The ImmGetCandidateWindow function gets information about the candidate list window.

BOOL ImmGetCandidateWindow(
  HIMC hIMC,                   
  DWORD dwBufLen,              
  LPCANDIDATEFORM lpCandidate  
);
 

Parameters

hIMC

Handle to the input context.

dwBufLen

Size, in bytes, of the buffer that receives the information.

lpCandidate

Pointer to the CANDIDATEFORM structure that receives 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.

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