Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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 CANDIDATEFORMstructure to retrieve. Windows Embedded CE supports four structures per context, ranging from 0 to 3.

lpCandidate

[out] Long pointer to the CANDIDATEFORMstructure 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

Header imm.h
Library Coreimm.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

CANDIDATEFORM