ImmGetCandidateWindow

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function gets information about the candidate list window.

Syntax

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

Parameters

• hIMC
  [in] Handle to the input context.

• dwIndex
  [in] Index of the CANDIDATEFORM structure to retrieve. Windows Embedded 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 Value

Nonzero indicates success. Zero indicates failure.

Remarks

In Windows Embedded 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.

Requirements

See Also

Reference

CANDIDATEFORM