ImmSetCandidateWindow

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

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 CANDIDATEFORM structure that contains information about the candidate window.

Return Value

Nonzero indicates success. Zero indicates failure.

Remarks

ImmSetCandidateWindow causes an IMN_SETCANDIDATEPOS message to be sent to the application.

In Japanese versions 1.0 and later, the ImmSetCandidateWindow function allows an index range of zero to 4 for the dwIndex member of the CANDIDATEFORM structure. 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