ImmGetCandidateWindow

The ImmGetCandidateWindow function gets information about the candidate list window.

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

Parameters

hIMC

[in] Handle to the input context.

dwBufLen

[in] Index of the candidate window.

lpCandidate

[out] Pointer to a 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.

Requirements

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

See Also

Input Method Editor Overview, Input Method Editor Functions, CANDIDATEFORM