CheckMenuItem function (winuser.h)

[CheckMenuItem is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use SetMenuItemInfo. ]

Sets the state of the specified menu item's check-mark attribute to either selected or clear.

Syntax

DWORD CheckMenuItem(
  [in] HMENU hMenu,
  [in] UINT  uIDCheckItem,
  [in] UINT  uCheck
);

Parameters

[in] hMenu

Type: HMENU

A handle to the menu of interest.

[in] uIDCheckItem

Type: UINT

The menu item whose check-mark attribute is to be set, as determined by the uCheck parameter.

[in] uCheck

Type: UINT

The flags that control the interpretation of the uIDCheckItem parameter and the state of the menu item's check-mark attribute. This parameter can be a combination of either MF_BYCOMMAND, or MF_BYPOSITION and MF_CHECKED or MF_UNCHECKED.

Return value

Type: DWORD

The return value specifies the previous state of the menu item (either MF_CHECKED or MF_UNCHECKED). If the menu item does not exist, the return value is –1.

Remarks

An item in a menu bar cannot have a check mark.

The uIDCheckItem parameter identifies a item that opens a submenu or a command item. For a item that opens a submenu, the uIDCheckItem parameter must specify the position of the item. For a command item, the uIDCheckItem parameter can specify either the item's position or its identifier.

Examples

For an example, see Simulating Check Boxes in a Menu.

Requirements

See also

Conceptual

EnableMenuItem

GetMenuItemID

Menus

Reference

SetMenuItemBitmaps

SetMenuItemInfo