IActiveIMMIME::GetCandidateListW Method

Retrieves a specified candidate list, copying the list to the specified buffer. Unicode implementation.

Syntax

HRESULT GetCandidateListW(
    HIMC hIMC,
    DWORD dwIndex,
    UINT uBufLen,
    CANDIDATELIST *pCandList,
    UINT *puCopied
);

Parameters

hIMC

[in] Handle to the input context.

dwIndex

[in] Unsigned long integer value that contains the zero-based index of the candidate list.

uBufLen

[in] Unsigned integer value that contains the size of the buffer, in bytes. If this is zero or if the buffer is insufficient to receive the candidate list, the method returns the size in bytes required to receive the complete candidate list to the variable specified by puCopied.

pCandList

[out] Address of the CANDIDATELIST structure that receives the candidate list.

puCopied

[out] Address of an unsigned integer variable that receives the number of bytes copied to the specified buffer if the buffer is sufficient. Otherwise it receives the size in bytes required to receive the complete candidate list.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

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