MENUITEMINFOA structure (winuser.h)
Contains information about a menu item.
Syntax
typedef struct tagMENUITEMINFOA {
UINT cbSize;
UINT fMask;
UINT fType;
UINT fState;
UINT wID;
HMENU hSubMenu;
HBITMAP hbmpChecked;
HBITMAP hbmpUnchecked;
ULONG_PTR dwItemData;
LPSTR dwTypeData;
UINT cch;
HBITMAP hbmpItem;
} MENUITEMINFOA, *LPMENUITEMINFOA;
Members
cbSize
Type: UINT
The size of the structure, in bytes. The caller must set this member to sizeof(MENUITEMINFO).
fMask
Type: UINT
Indicates the members to be retrieved or set. This member can be one or more of the following values.
fType
Type: UINT
The menu item type. This member can be one or more of the following values.
The MFT_BITMAP, MFT_SEPARATOR, and MFT_STRING values cannot be combined with one another. Set fMask to MIIM_TYPE to use fType.
fType is used only if fMask has a value of MIIM_FTYPE.
| Value | Meaning |
|---|---|
|
Displays the menu item using a bitmap. The low-order word of the
dwTypeData member is the bitmap handle, and the
cch member is ignored.
MFT_BITMAP is replaced by MIIM_BITMAP and hbmpItem. |
|
Places the menu item on a new line (for a menu bar) or in a new column (for a drop-down menu, submenu, or shortcut menu). For a drop-down menu, submenu, or shortcut menu, a vertical line separates the new column from the old. |
|
Places the menu item on a new line (for a menu bar) or in a new column (for a drop-down menu, submenu, or shortcut menu). For a drop-down menu, submenu, or shortcut menu, the columns are not separated by a vertical line. |
|
Assigns responsibility for drawing the menu item to the window that owns the menu. The window receives a WM_MEASUREITEM message before the menu is displayed for the first time, and a WM_DRAWITEM message whenever the appearance of the menu item must be updated. If this value is specified, the dwTypeData member contains an application-defined value. |
|
Displays selected menu items using a radio-button mark instead of a check mark if the hbmpChecked member is NULL. |
|
Right-justifies the menu item and any subsequent items. This value is valid only if the menu item is in a menu bar. |
|
Specifies that menus cascade right-to-left (the default is left-to-right). This is used to support right-to-left languages, such as Arabic and Hebrew. |
|
Specifies that the menu item is a separator. A menu item separator appears as a horizontal dividing line. The dwTypeData and cch members are ignored. This value is valid only in a drop-down menu, submenu, or shortcut menu. |
|
Displays the menu item using a text string. The
dwTypeData member is the pointer to a null-terminated string, and the
cch member is the length of the string.
MFT_STRING is replaced by MIIM_STRING. |
fState
Type: UINT
The menu item state. This member can be one or more of these values. Set fMask to MIIM_STATE to use fState.
wID
Type: UINT
An application-defined value that identifies the menu item. Set fMask to MIIM_ID to use wID.
hSubMenu
Type: HMENU
A handle to the drop-down menu or submenu associated with the menu item. If the menu item is not an item that opens a drop-down menu or submenu, this member is NULL. Set fMask to MIIM_SUBMENU to use hSubMenu.
hbmpChecked
Type: HBITMAP
A handle to the bitmap to display next to the item if it is selected. If this member is NULL, a default bitmap is used. If the MFT_RADIOCHECK type value is specified, the default bitmap is a bullet. Otherwise, it is a check mark. Set fMask to MIIM_CHECKMARKS to use hbmpChecked.
hbmpUnchecked
Type: HBITMAP
A handle to the bitmap to display next to the item if it is not selected. If this member is NULL, no bitmap is used. Set fMask to MIIM_CHECKMARKS to use hbmpUnchecked.
dwItemData
Type: ULONG_PTR
An application-defined value associated with the menu item. Set fMask to MIIM_DATA to use dwItemData.
dwTypeData
Type: LPTSTR
The contents of the menu item. The meaning of this member depends on the value of fType and is used only if the MIIM_TYPE flag is set in the fMask member.
To retrieve a menu item of type MFT_STRING, first find the size of the string by setting the dwTypeData member of MENUITEMINFO to NULL and then calling GetMenuItemInfo. The value of cch+1 is the size needed. Then allocate a buffer of this size, place the pointer to the buffer in dwTypeData, increment cch, and call GetMenuItemInfo once again to fill the buffer with the string. If the retrieved menu item is of some other type, then GetMenuItemInfo sets the dwTypeData member to a value whose type is specified by the fType member.
When using with the SetMenuItemInfo function, this member should contain a value whose type is specified by the fType member.
dwTypeData is used only if the MIIM_STRING flag is set in the fMask member
cch
Type: UINT
The length of the menu item text, in characters, when information is received about a menu item of the MFT_STRING type. However, cch is used only if the MIIM_TYPE flag is set in the fMask member and is zero otherwise. Also, cch is ignored when the content of a menu item is set by calling SetMenuItemInfo.
Note that, before calling GetMenuItemInfo, the application must set cch to the length of the buffer pointed to by the dwTypeData member. If the retrieved menu item is of type MFT_STRING (as indicated by the fType member), then GetMenuItemInfo changes cch to the length of the menu item text. If the retrieved menu item is of some other type, GetMenuItemInfo sets the cch field to zero.
The cch member is used when the MIIM_STRING flag is set in the fMask member.
hbmpItem
Type: HBITMAP
A handle to the bitmap to be displayed, or it can be one of the values in the following table. It is used when the MIIM_BITMAP flag is set in the fMask member.
| Value | Meaning |
|---|---|
|
A bitmap that is drawn by the window that owns the menu. The application must process the WM_MEASUREITEM and WM_DRAWITEM messages. |
|
Close button for the menu bar. |
|
Disabled close button for the menu bar. |
|
Minimize button for the menu bar. |
|
Disabled minimize button for the menu bar. |
|
Restore button for the menu bar. |
|
Close button for the submenu. |
|
Maximize button for the submenu. |
|
Minimize button for the submenu. |
|
Restore button for the submenu. |
|
Windows icon or the icon of the window specified in dwItemData. |
Remarks
The MENUITEMINFO structure is used with the GetMenuItemInfo, InsertMenuItem, and SetMenuItemInfo functions.
The menu can display items using text, bitmaps, or both.
Note
The winuser.h header defines MENUITEMINFO 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 | winuser.h (include Windows.h) |
See also
Conceptual
Reference
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for