This function retrieves a specified candidate list, copying the list to the specified buffer.
At a Glance
| Header file: | Imm.h |
| Windows CE versions: | 2.10 and later (Japanese version 1.0 and later) |
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] 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.