The IsDlgButtonChecked function determines whether a button control has a check mark next to it or whether a three-state button control is grayed, checked, or neither.
Syntax
UINT IsDlgButtonChecked( HWND hDlg,
int nIDButton
);
Parameters
hDlg
[in] Handle to the dialog box that contains the button control.
nIDButton
[in] Specifies the identifier of the button control.
Return Value
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.
If the button has any other style, the return value is zero.
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
The IsDlgButtonChecked function sends a BM_GETCHECK message to the specified button control.
Example
For an example, see the section titled "Creating a Modeless Dialog Box" in Using Dialog Boxes.
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
This inline function sets the check state of a radio button or check box in a specified dialog box.
__inline BOOL WINAPI CheckDlgButton(
HWND hDlg,
int nIDButton,
UINT uCheck
);
Parameters
hDlg
[in] Handle to the dialog box that contains the radio button or check box.
nIDButton
[in] Integer that specifies the identifier of the radio button or check box for which you want to set the check state.
uCheck
[in] Unsigned integer that specifies the check state for the radio button or check box. The following table shows the possible values. Value Description
BST_CHECKED Sets the button state to checked.
BST_INDETERMINATE Sets the button state to grayed, indicating an indeterminate state. Use this value only if the button has the BS_3STATE or BS_AUTO3STATE style.
BST_UNCHECKED Sets the button state to unchecked.
Return Values
This function always returns zero.
Remarks
This function has no effect on push buttons.
This function uses the SendDlgItemMessage function to send a BM_SETCHECK message to the specified button control in the specified dialog box.
Requirements
OS Versions: Windows CE .NET 4.0 and later.
Header: Windows.h.
Link Library: Coredll.lib.
See Also
IsDlgButtonChecked | SendDlgItemMessage | BM_SETCHECK