Button_GetCheck macro (windowsx.h)

Gets the check state of a radio button or check box. You can use this macro or send the BM_GETCHECK message explicitly.

Syntax

LRESULT Button_GetCheck(
   HWND hwndCtl
);

Parameters

hwndCtl

Type: HWND

A handle to the button control.

Return value

Type: LRESULT

The return value from a button created with the BS_AUTOCHECKBOX, BS_AUTORADIOBUTTON, BS_AUTO3STATE, BS_CHECKBOX, BS_RADIOBUTTON, or BS_3STATE style can be one of the following:

Return code Description
BST_CHECKED Button is checked.
BST_INDETERMINATE Button is grayed, indicating an indeterminate state (applies only if the button has the BS_3STATE or BS_AUTO3STATE style).
BST_UNCHECKED Button is cleared.

Remarks

If the button has a style other than those listed, the return value is zero.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header windowsx.h