CANDIDATELIST structure

Contains information about a candidate list.

Syntax

typedef struct {
  DWORD dwSize;
  DWORD dwStyle;
  DWORD dwCount;
  DWORD dwSelection;
  DWORD dwPageStart;
  DWORD dwPageSize;
  DWORD dwOffset[1];
} CANDIDATELIST;

Members

dwSize

Unsigned long integer value that contains the size, in bytes, of the structure, the offset array, and all candidate strings.

dwStyle

Unsigned long integer value that contains the candidate style values. This can be one or more of the following values.

IME_CAND_UNKNOWN

Candidates are in a style other than the ones in the following list.

IME_CAND_READ

Candidates are in the same reading.

IME_CAND_CODE

Candidates are in a code range.

IME_CAND_MEANING

Candidates are in the same meaning.

IME_CAND_RADICAL

Candidates use the same radical character.

IME_CAND_STROKES

Candidates are in the same number of strokes.

dwCount

Unsigned long integer value that contains the number of candidate strings.

dwSelection

Unsigned long integer value that contains the index of the selected candidate string.

dwPageStart

Unsigned long integer value that contains the index of the first candidate string in the candidate window. This varies as the user presses the PAGE UP and PAGE DOWN keys.

dwPageSize

Unsigned long integer value that contains the number of candidate strings to be shown in one page in the candidate window. The user can move to the next page by pressing Active IME-defined keys, such as the PAGE UP or PAGE DOWN key. If this number is zero, an application can define a proper value by itself.

dwOffset

Address of an array of unsigned long integer values that contains the offset to the start of the first candidate string, relative to the start of this structure. The offsets for subsequent strings immediately follow this member, forming an array of 32-bit offsets.

Remarks

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

Requirements