ImmGetCandidateList

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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

Syntax

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

Parameters

• hIMC
  [in] Handle to the input context.

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

• lpCandList
  [out] Long pointer to the CANDIDATELIST structure that receives the candidate list.

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

Return Value

The number of bytes copied to the specified buffer indicates success. Zero indicates failure.

Requirements

See Also

Reference

CANDIDATELIST