IPCANDIDATE (Windows Embedded CE 6.0)

1/6/2010

This structure contains information about the candidate list.

Syntax

typedef struct tagIPCANDIDATE {
  DWORD dwSize;
  DWORD dwFlags;
  INT iSelIndex;
  INT nCandidate;
  DWORD dwPrivateDataOffset;
  DWORD dwPrivateDataSize;
  DWORD dwOffset[1];
} IPCANDIDATE, *PIPCANDIDATE;

Members

  • dwSize
    Size, in bytes, of the structure, the offset array, and all candidate strings.
  • dwFlags
    Set the value to zero. Reserved.
  • iSelIndex
    Index of the selected candidate string.
  • nCandidate
    Number of candidate strings.
  • dwPrivateDataOffset
    Set the value to zero. Reserved.
  • dwPrivateDataSize
    Set the value to zero. Reserved.
  • dwOffset
    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

All candidate strings follows the last dwOffset member. The candidate string needs to be null-terminated.

The following table provides an example of an IPCANDIDATE structure on an Intel x86-compatible CPU with a 32-bit architecture CPU.

Offset (in dec) Data (in hex) Member Description

0

00 44 00 00

dwSize

The size of this structure is 68 bytes.

4

00 00 00 00

dwFlags

0

8

00 02 00 00

iSelIndex

The third candidate, 'DE', is selected.

12

00 05 00 00

nCandidate

This structure has five candidates.

16

00 00 00 00

dwPrivateDataOffset

0

20

00 00 00 00

dwPrivateDataSize

0

24

00 2C 00 00

dwIndex[0]

The offset 44 points to 'A'.

28

00 30 00 00

dwIndex[1]

The offset 48 points to 'BC'.

32

00 36 00 00

dwIndex[2]

The offset 54 points to 'DE'.

36

00 3C 00 00

dwIndex[3]

The offset 60 points to 'F'.

40

00 40 00 00

dwIndex[4]

The offset 64 points to 'G'.

44

00 41 00 00

L'A'

The first candidate.

48

00 42 00 43 00 00

L'BC'

The second candidate.

54

00 44 00 45 00 00

L'DE'

The third candidate.

60

00 46 00 00

L'F'

The fourth candidate.

64

00 47 00 00

L'G'

The fifth candidate.

Requirements

Header msime.h
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Other Resources

Japanese Pocket IME Structures