CANDIDATEFORM structure

Contains the position information for the candidate window.

Syntax

typedef struct {
  DWORD dwIndex;
  DWORD dwStyle;
  POINT ptCurrentPos;
  RECT  rcArea;
} CANDIDATEFORM;

Members

dwIndex

Unsigned long integer value that contains the candidate list identifier. This can be a value between 0 and 31.

dwStyle

Unsigned long integer value that contains the position style. This can be one of the following values:

CFS_CANDIDATEPOS

Displays the upper-left corner of the candidate list window at the position given by ptCurrentPos. The coordinates are relative to the upper-left corner of the window containing the list window and are subject to adjustment by the system.

CFS_EXCLUDE

Exclude the candidate window from the area given by rcArea. The ptCurrentPos member specifies the coordinates of the current point of interest—typically the caret position.

ptCurrentPos

POINT value that contains the coordinates of the upper-left corner of the candidate window or the caret position, depending on the value of dwStyle.

rcArea

RECT value that contains the coordinates of the upper-left and lower-right corners of the exclusion area.

Remarks

This structure maps to the CANDIDATEFORM structure documented in the Windows Software Development Kit (SDK).

Requirements