windows_programming_notes.nbk: Home | Index | Next Page: IsWindow | Previous Page: IsDialogMessage

 IsDlgButtonChecked

The IsDlgButtonChecked function determines whether a button control is checked or whether a three-state button control is checked, unchecked, or indeterminate.

Syntax

    UINT IsDlgButtonChecked(
        HWND hDlg,
        int  nIDButton
    );

Parameters

• hDlg
  [in] A handle to the dialog box that contains the button control.
• nIDButton
  [in] 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 styles can be one of the values in the following table. If the button has any other style, the return value is zero.

BST_CHECKED The button is checked. BST_INDETERMINATE The button is in an indeterminate state (applies only if the button has the BS_3STATE or BS_AUTO3STATE style). BST_UNCHECKED The button is not checked.

Remarks

The IsDlgButtonChecked function sends a BM_GETCHECK message to the specified button control.

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

windows_programming_notes.nbk: Home | Index | Next Page: IsWindow | Previous Page: IsDialogMessage

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time