IMEMENUITEMINFOA structure (imm.h)

Contains information about IME menu items.

Syntax

typedef struct tagIMEMENUITEMINFOA {
  UINT    cbSize;
  UINT    fType;
  UINT    fState;
  UINT    wID;
  HBITMAP hbmpChecked;
  HBITMAP hbmpUnchecked;
  DWORD   dwItemData;
  CHAR    szString[IMEMENUITEM_STRING_SIZE];
  HBITMAP hbmpItem;
} IMEMENUITEMINFOA, *PIMEMENUITEMINFOA, *NPIMEMENUITEMINFOA, *LPIMEMENUITEMINFOA;

Members

cbSize

Size, in bytes, of the structure.

fType

Menu item type. This member can have one of the following values.

Value Meaning
IMFT_RADIOCCHECK Display checked menu items using a radio-button mark instead of a check mark if the hbmpChecked member is NULL.
IMFT_SEPARATOR Menu item is a separator. A menu item separator appears as a horizontal dividing line. The hbmpItem and szString members are ignored in this case.
IMFT_SUBMENU Menu item is a submenu.

fState

Menu item state. This member can have one or more of the following values:

Value Meaning
IMFS_CHECKED The menu item is checked. For more information, see the description of the hbmpChecked member.
IMFS_DEFAULT The menu item is the default. A menu can contain only one default menu item, which is displayed in bold.
IMFS_DISABLED The menu item is disabled and appears dimmed so it cannot be selected. This is equivalent to IMFS_GRAYED.
IMFS_ENABLED The menu item is enabled. This is the default state.
IMFS_GRAYED The menu item is disabled and appears dimmed so it cannot be selected. This is equivalent to IMFS_DISABLED.
IMFS_HILITE The menu item is highlighted.
IMFS_UNCHECKED The menu item is unchecked. For more information about unchecked menu items, see the description of the hbmpUnchecked member.
IMFS_UNHILITE The menu item is not highlighted. This is the default state.

wID

Application-defined 16-bit value that identifies the menu item.

hbmpChecked

Handle to the bitmap to display next to the item if it is checked. If this member is NULL, a default bitmap is used. If the IMFT_RADIOCHECK type value is specified, the default bitmap is a bullet. Otherwise, it is a check mark.

hbmpUnchecked

Handle to the bitmap to display next to the item if it is not checked. If this member is NULL, no bitmap is used.

dwItemData

Application-defined value associated with the menu item.

szString[IMEMENUITEM_STRING_SIZE]

Content of the menu item. This is a null-terminated string.

hbmpItem

Handle to a bitmap to display.

Remarks

Note

The imm.h header defines IMEMENUITEMINFO as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header imm.h (include Immdev.h, Windows.h)

See also

ImmGetImeMenuItems

Input Method Manager

Input Method Manager Structures