Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This inline function retrieves the check state of a radio button or check box in a specified dialog box.

Syntax 

__inline UINT WINAPI IsDlgButtonChecked(
  HWND 
hDlg,
  int 
nIDButton
);

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 retrieve the check state.

Return Value

The following table shows the possible return values if you created the button with the BS_AUTOCHECKBOX, BS_AUTORADIOBUTTON, BS_AUTO3STATE, BS_CHECKBOX, BS_RADIOBUTTON, or BS_3STATE style.

Value Description

BST_CHECKED

The button is checked.

BST_INDETERMINATE

The button is grayed, indicating an indeterminate state. This value applies only if the button has the BS_3STATE or BS_AUTO3STATE style.

BST_UNCHECKED

The button is unchecked.

If the button has any other style, the return value is zero.

Remarks

This function uses the SendDlgItemMessagefunction to send a BM_GETCHECKmessage to the specified button control in the specified dialog box.

Requirements

Header windows.h
Library coredll.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also