Share via

ImmGetCandidateList

  • Article

This 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
    [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] 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

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

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.10 and later (Japanese version 1.0 and later) Imm.h   Coreimm.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

CANDIDATELIST

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.