The SetMenuItemBitmaps function associates the specified bitmap with a menu item. Whether the menu item is selected or clear, the system displays the appropriate bitmap next to the menu item.

Syntax

BOOL SetMenuItemBitmaps(      
    HMENU hMenu,
    UINT uPosition,
    UINT uFlags,
    HBITMAP hBitmapUnchecked,
    HBITMAP hBitmapChecked
);

Parameters

hMenu

[in] Handle to the menu containing the item to receive new check-mark bitmaps.

uPosition

[in] Specifies the menu item to be changed, as determined by the uFlags parameter.

uFlags

[in] Specifies how the uPosition parameter is interpreted. The uFlags parameter must be one of the following values.

MF_BYCOMMAND

Indicates that uPosition gives the identifier of the menu item. If neither MF_BYCOMMAND nor MF_BYPOSITION is specified, MF_BYCOMMAND is the default flag.

MF_BYPOSITION

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

hBitmapUnchecked

[in] Handle to the bitmap displayed when the menu item is not selected.

hBitmapChecked

[in] Handle to the bitmap displayed when the menu item is selected.

Return Value

If the function succeeds, the return value is nonzero.

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

Remarks

If either the hBitmapUnchecked or hBitmapChecked parameter is NULL, the system displays nothing next to the menu item for the corresponding check state. If both parameters are NULL, the system displays the default check-mark bitmap when the item is selected, and removes the bitmap when the item is not selected.

When the menu is destroyed, these bitmaps are not destroyed; it is up to the application to destroy them.

The selected and clear bitmaps should be monochrome. The system uses the Boolean AND operator to combine bitmaps with the menu so that the white part becomes transparent and the black part becomes the menu-item color. If you use color bitmaps, the results may be undesirable.

Use the GetSystemMetrics function with the CXMENUCHECK and CYMENUCHECK values to retrieve the bitmap dimensions.

Example

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

Function Information

Minimum DLL Version	user32.dll
Header	Declared in Winuser.h, include Windows.h
Import library	User32.lib
Minimum operating systems	Windows 95, Windows NT 3.1
Unicode	Implemented as Unicode version.

See Also

Menus