ImmGetCandidateWindow

This function gets information about the candidate list window.

At a Glance

Header file: Imm.h
Windows CE versions: 2.10 and later (Japanese version 1.0 and later)

Syntax

BOOL ImmGetCandidateWindow(HIMC hIMC, DWORD dwIndex,
LPCANDIDATEFORM lpCandidate);

Parameters

hIMC

[in] Handle to the input context.

dwIndex

[in] Specifies the index of the CANDIDATEFORM structure to retrieve. Windows CE supports four structures per context, ranging from 0 to 3.

lpCandidate

[out] Long pointer to the CANDIDATEFORM structure that receives information about the candidate window.

Return Values

Nonzero indicates success. Zero indicates failure.

Remarks

In Windows CE Japanese version 1.0 and later, the following parameter is used instead of dwIndex:

dwBufLen

Size, in bytes, of the buffer that receives the information.

See Also

CANDIDATEFORM