Share via

CANDIDATELIST

  • Article

This structure contains information about a candidate list.

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

Members

  • dwSize
    Specifies the size, in bytes, of the structure, the offset array, and all candidate strings

  • dwStyle
    Specifies candidate style values. It can be one or more of the following values:

    Value Description
    IME_CAND_UNKNOWN Candidates are in a style other than listed here.
    IME_CAND_READ Candidates are in same reading.
    IME_CAND_CODE Candidates are in a code range.
    IME_CAND_MEANING Candidates are in same meaning.
    IME_CAND_RADICAL Candidates use the same radical character.
    IME_CAND_STROKES Candidates are in same number of strokes.

    For the IME_CAND_CODE style, the candidate list has a special structure depending on the value of the dwCount member. If dwCount is 1, the dwOffset member contains a single DBCS character rather than an offset, and no candidate string is provided. If the dwCount member is greater than 1, the dwOffset member contains valid offsets, and the candidate strings are text representations of individual DBCS character values in hexadecimal notation.

  • dwCount
    Specifies the number of candidate strings.

  • dwSelection
    Specifies the index of the selected candidate string.

  • dwPageStart
    Specifies 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
    Specifies 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 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
    Specifies 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

The candidate strings immediately follow the last offset in the dwOffset array.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.1 and later (Japanese version 1.0 and later) Wceemul.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.