ImmGetCandidateList

The ImmGetCandidateList function retrieves a specified candidate list, copying the list to the specified buffer.

DWORD ImmGetCandidateList(
  HIMC hIMC,                    
  DWORD dwIndex,                
  LPCANDIDATELIST lpCandList,   
  DWORD dwBufLen                
);

Parameters

hIMC

[in] Handle to the input context.

deIndex

[in] Zero-based index of the candidate list.

lpCandList

[out] Pointer to a CANDIDATELIST structure that receives the candidate list.

dwBufLen

[in] Specifies the size of the buffer, in bytes. If zero, the function returns the size in bytes required to receive the complete candidate list.

Return Values

If the function succeeds, the return value is the number of bytes copied to the buffer specified by lpCandList.

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

See Also

Input Method Editor Overview, Input Method Editor Functions, CANDIDATELIST