ImmGetCandidateListCountA function (imm.h)
Retrieves the size of the candidate lists.
Syntax
DWORD ImmGetCandidateListCountA(
HIMC unnamedParam1,
[out] LPDWORD lpdwListCount
);
Parameters
unnamedParam1
[out] lpdwListCount
Pointer to the buffer in which this function retrieves the size of the candidate lists.
Return value
Returns the number of bytes required for all candidate lists if successful, or 0 otherwise.
Remarks
Applications typically call this function in response to an IMN_OPENCANDIDATE or IMN_CHANGECANDIDATE command.
Note
The imm.h header defines ImmGetCandidateListCount as an alias which 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 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 |