ImmGetCandidateListA function (imm.h)
Retrieves a candidate list.
Syntax
DWORD ImmGetCandidateListA(
HIMC unnamedParam1,
[in] DWORD deIndex,
[out, optional] LPCANDIDATELIST lpCandList,
[in] DWORD dwBufLen
);
Parameters
unnamedParam1
[in] deIndex
Zero-based index of the candidate list.
[out, optional] lpCandList
Pointer to a CANDIDATELIST structure in which the function retrieves the candidate list.
[in] dwBufLen
Size, in bytes, of the buffer to receive the candidate list. The application can specify 0 for this parameter if the function is to return the required size of the output buffer only.
Return value
Returns the number of bytes copied to the candidate list buffer if successful. If the application has supplied 0 for the dwBufLen parameter, the function returns the size required for the candidate list buffer.
The function returns 0 if it does not succeed.
Remarks
Note
The imm.h header defines ImmGetCandidateList as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only],East Asian language support installed. |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | imm.h (include Immdev.h, Windows.h) |
| Library | Imm32.lib |
| DLL | Imm32.dll |