IActiveIMMApp::GetCandidateWindow Method

---

Retrieves information about the candidate list window.

Syntax

HRESULT GetCandidateWindow(
    HIMC hIMC,
    DWORD dwIndex,
    CANDIDATEFORM *pCandidate
);

Parameters

hIMC

[in] Handle to the input context.

dwIndex

[in] Unsigned long integer value that contains the size, in bytes, of the buffer.

pCandidate

[out] Address of a CANDIDATEFORM structure that receives information about the candidate window.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

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