IActiveIMMIME::GetCandidateListCountA Method

Retrieves the size, in bytes, of the candidate list. ANSI implementation.

Syntax

HRESULT GetCandidateListCountA(
    HIMC hIMC,
    DWORD *pdwListSize,
    DWORD *pdwBufLen
);

Parameters

hIMC

[in] Handle to the input context.

pdwListSize

[out] Address of an unsigned long integer value that receives the size of the candidate list.

pdwBufLen

[out] Address of an unsigned long integer value that contains the number of bytes required to receive all candidate lists.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

This method maps to the ImmGetCandidateListCount function documented in the Microsoft® Platform Software Development Kit (SDK).