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 sets information about the candidate list window.

Syntax 

BOOL ImmSetCandidateWindow(
  HIMC 
hIMC, 
  LPCANDIDATEFORM 
lpCandidate
);

Parameters

hIMC

[in] Handle to the input context.

lpCandidate

[in] Long pointer to the CANDIDATEFORMstructure that contains information about the candidate window.

Return Value

Nonzero indicates success. Zero indicates failure.

Remarks

ImmSetCandidateWindowcauses an IMN_SETCANDIDATEPOSmessage to be sent to the application.

In Japanese versions 1.0 and later, the ImmSetCandidateWindowfunction allows an index range of zero to 4 for the dwIndexmember of the CANDIDATEFORMstructure. In Windows CE 2.10 and later, an index range of 0 to 3 is allowed.

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