CWnd::HiliteMenuItem

Syntax

BOOL HiliteMenuItem( CMenu* pMenu, UINT nIDHiliteItem, UINT nHilite );

Parameters

pMenu

Identifies the top-level menu that contains the item to be highlighted.

nIDHiliteItem

Specifies the integer identifier of the menu item or the offset of the menu item in the menu, depending on the value of the nHilite parameter.

nHilite

Specifies whether the menu item is highlighted or the highlight is removed. It can be a combination of MF_HILITE or MF_UNHILITE with MF_BYCOMMAND or MF_BYPOSITION. The values can be combined using the bitwise OR operator. These values have the following meanings:

Value Meaning

MF_BYCOMMAND Interprets nIDHiliteItem as the menu-item ID (the default interpretation).
MF_BYPOSITION Interprets nIDHiliteItem as an offset.
MF_HILITE Highlights the item. If this value is not given, highlighting is removed from the item.
MF_UNHILITE Removes highlighting from the item.

Remarks

Highlights or removes the highlighting from a top-level (menu-bar) menu item.

Return Value

Specifies whether the menu item was highlighted. TRUE if the item was highlighted; otherwise FALSE.

See Also

CMenu::ModifyMenu, ::HiliteMenuItem