ImmGetCandidateList (Windows CE 5.0)

Send Feedback

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

DWORD ImmGetCandidateList(  HIMChIMC,  DWORDdeIndex,  LPCANDIDATELISTlpCandList,  DWORD dwBufLen );


  • 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 Values

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


OS Versions: Windows CE .NET 4.0 and later.
Header: Imm.h.
Link Library: Coreimm.lib.

See Also


Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.