ImmGetCandidateList

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

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

Parameters

hIMC

Handle to the input context.

deIndex

Zero-based index of the candidate list.

lpCandList

Pointer to the CANDIDATELIST structure that receives the candidate list.

dwBufLen

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 specified buffer.

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

See Also

Input Method Editor Overview, Input Method Editor Functions, CANDIDATELIST