ImmGetCandidateListCount

The ImmGetCandidateListCount function retrieves the size, in bytes, of the candidate lists.

DWORD ImmGetCandidateListCount(
  HIMC hIMC,             
  LPDWORD lpdwListCount  
);

Parameters

hIMC

[in] Handle to the input context.

lpdwListCount

[out] Pointer to the buffer that receives the size of the candidate lists.

Return Values

If successful, returns the number of bytes required to receive all candidate lists.

If the function fails, it returns zero.

Remarks

Applications typically call this function in response to a IMN_OPENCANDIDATE or IMN_CHANGECANDIDATE command.

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.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Input Method Editor Overview, Input Method Editor Functions, IMN_CHANGECANDIDATE, IMN_OPENCANDIDATE