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 sets the check state of a radio button or check box in a specified dialog box.

Syntax 

__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 Value

This function always returns zero.

Remarks

This function has no effect on push buttons.

This function uses the SendDlgItemMessagefunction to send a BM_SETCHECKmessage 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