This topic has not yet been rated - Rate this topic

InsertMenuItem function

Applies to: desktop apps only

Inserts a new menu item at the specified position in a menu.

Syntax

Copy

BOOL WINAPI InsertMenuItem(
  __in  HMENU hMenu,
  __in  UINT uItem,
  __in  BOOL fByPosition,
  __in  LPCMENUITEMINFO lpmii
);

Parameters

hMenu [in]

Type: HMENU

A handle to the menu in which the new menu item is inserted.

uItem [in]

Type: UINT

The identifier or position of the menu item before which to insert the new item. The meaning of this parameter depends on the value of fByPosition.

fByPosition [in]

Type: BOOL

Controls the meaning of uItem. If this parameter is FALSE, uItem is a menu item identifier. Otherwise, it is a menu item position. See Accessing Menu Items Programmatically for more information.

lpmii [in]

Type: LPCMENUITEMINFO

A pointer to a MENUITEMINFO structure that contains information about the new menu item.

Return value

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, use the GetLastError function.

Remarks

The application must call the DrawMenuBar function whenever a menu changes, whether the menu is in a displayed window.

In order for keyboard accelerators to work with bitmap or owner-drawn menu items, the owner of the menu must process the WM_MENUCHAR message. See Owner-Drawn Menus and the WM_MENUCHAR Message for more information.

Examples

For an example, see Example of Menu-Item Bitmaps.

Requirements

Minimum supported client	Windows 2000 Professional
Minimum supported server	Windows 2000 Server
Header	Winuser.h (include Windows.h)
Library	User32.lib
DLL	User32.dll
Unicode and ANSI names	InsertMenuItemW (Unicode) and InsertMenuItemA (ANSI)