IsDlgButtonChecked 関数 (winuser.h)

  • [アーティクル]

IsDlgButtonChecked 関数は、ボタン コントロールをチェックするか、3 状態のボタン コントロールをオンにするか、オフにするか、不確定にするかを決定します。

構文

UINT IsDlgButtonChecked(
  [in] HWND hDlg,
  [in] int  nIDButton
);

パラメーター

[in] hDlg

種類: HWND

ボタン コントロールを含むダイアログ ボックスへのハンドル。

[in] nIDButton

型: int

ボタン コントロールの識別子。

戻り値

型: UINT

BS_AUTOCHECKBOX、BS_AUTORADIOBUTTON、BS_AUTO3STATE、BS_CHECKBOX、BS_RADIOBUTTON、またはBS_3STATEスタイルで作成されたボタンからの戻り値は、次の表のいずれかの値になります。 ボタンに他のスタイルがある場合、戻り値は 0 になります。

リターン コード 説明
BST_CHECKED
 ボタンがオンになっています。
BST_INDETERMINATE
 ボタンが不確定な状態です (ボタンに BS_3STATE または BS_AUTO3STATE スタイルがある場合にのみ適用されます)。
BST_UNCHECKED
 ボタンはオンではありません。

解説

IsDlgButtonChecked 関数は、指定したボタン コントロールにBM_GETCHECKメッセージを送信します。

例

例については、「 ダイアログ ボックスの使用」の「モードレス ダイアログ ボックスの作成」というタイトルのセクションを参照してください。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー winuser.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll
API セット ext-ms-win-ntuser-dialogbox-l1-1-0 (Windows 8 で導入)

関連項目

CheckDlgButton