BM_GETSTATE message

Retrieves the state of a button or check box. You can send this message explicitly or use the Button_GetState macro.

Parameters

wParam

Not used; must be zero.

lParam

Not used; must be zero.

Return value

The return value specifies the current state of the button. It is a combination of the following values.

Return code	Description
BST_CHECKED	The button is checked.
BST_DROPDOWNPUSHED	Windows Vista. The button is in the drop-down state. Applies only if the button has the TBSTYLE_DROPDOWN style.
BST_FOCUS	The button has the keyboard focus.
BST_HOT	The button is hot; that is, the mouse is hovering over it.
BST_INDETERMINATE	The state of the button is indeterminate. Applies only if the button has the BS_3STATE or BS_AUTO3STATE style.
BST_PUSHED	The button is being shown in the pushed state.
BST_UNCHECKED	No special state. Equivalent to zero.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	Winuser.h (include Windows.h)

See also

Reference

BM_GETCHECK

BM_SETSTATE