CheckMenuItem Function in Delphi

CheckMenuItem Function

---

The CheckMenuItem function sets the state of the specified menu item's check-mark attribute to either selected or clear.

Syntax

DWORD CheckMenuItem(      

    HMENU hmenu,
    UINT uIDCheckItem,
    UINT uCheck
);

Parameters

hmenu

[in] Handle to the menu of interest.

uIDCheckItem

[in] Specifies the menu item whose check-mark attribute is to be set, as determined by the uCheck parameter.

uCheck

[in] Specifies 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.

MF_BYCOMMAND

Indicates that the uIDCheckItem parameter gives the identifier of the menu item. The MF_BYCOMMAND flag is the default, if neither the MF_BYCOMMAND nor MF_BYPOSITION flag is specified.

MF_BYPOSITION

Indicates that the uIDCheckItem parameter gives the zero-based relative position of the menu item.

MF_CHECKED

Sets the check-mark attribute to the selected state.

MF_UNCHECKED

Sets the check-mark attribute to the clear state.

Return Value

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

Note  The CheckMenuItem function has been superseded by the SetMenuItemInfo function. You can still use CheckMenuItem, however, if you do not need any of the extended features of SetMenuItemInfo.

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.