Win32 API 日本語リファレンス
ホームUI.Controls › CheckDlgButton

CheckDlgButton

関数
ダイアログ内ボタンのチェック状態を設定する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// USER32.dll
#include <windows.h>

BOOL CheckDlgButton(
    HWND hDlg,
    INT nIDButton,
    DLG_BUTTON_CHECK_STATE uCheck
);

パラメーター

名前方向説明
hDlgHWNDinボタンを含むダイアログボックスへのハンドルです。
nIDButtonINTin変更するボタンの識別子です。
uCheckDLG_BUTTON_CHECK_STATEin

ボタンのチェック状態です。このパラメーターには、次のいずれかの値を指定できます。

意味
BST_CHECKED
ボタンの状態をチェック済みに設定します。
BST_INDETERMINATE
ボタンの状態をグレー表示に設定し、不確定状態を示します。この値は、ボタンが BS_3STATE または BS_AUTO3STATE スタイルを持つ場合にのみ使用してください。
BST_UNCHECKED
ボタンの状態を未チェックに設定します。

戻り値の型: BOOL

公式ドキュメント

ボタンコントロールのチェック状態を変更します。

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

CheckDlgButton 関数は、指定したダイアログボックス内の指定したボタンコントロールに BM_SETCHECK メッセージを送信します。

例については、ダイアログボックスの使用モードレスダイアログボックスの作成 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

BOOL CheckDlgButton(
    HWND hDlg,
    INT nIDButton,
    DLG_BUTTON_CHECK_STATE uCheck
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CheckDlgButton(
    IntPtr hDlg,   // HWND
    int nIDButton,   // INT
    uint uCheck   // DLG_BUTTON_CHECK_STATE
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CheckDlgButton(
    hDlg As IntPtr,   ' HWND
    nIDButton As Integer,   ' INT
    uCheck As UInteger   ' DLG_BUTTON_CHECK_STATE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hDlg : HWND
' nIDButton : INT
' uCheck : DLG_BUTTON_CHECK_STATE
Declare PtrSafe Function CheckDlgButton Lib "user32" ( _
    ByVal hDlg As LongPtr, _
    ByVal nIDButton As Long, _
    ByVal uCheck As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CheckDlgButton = ctypes.windll.user32.CheckDlgButton
CheckDlgButton.restype = wintypes.BOOL
CheckDlgButton.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    ctypes.c_int,  # nIDButton : INT
    wintypes.DWORD,  # uCheck : DLG_BUTTON_CHECK_STATE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
CheckDlgButton = Fiddle::Function.new(
  lib['CheckDlgButton'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_INT,  # nIDButton : INT
    -Fiddle::TYPE_INT,  # uCheck : DLG_BUTTON_CHECK_STATE
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn CheckDlgButton(
        hDlg: *mut core::ffi::c_void,  // HWND
        nIDButton: i32,  // INT
        uCheck: u32  // DLG_BUTTON_CHECK_STATE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool CheckDlgButton(IntPtr hDlg, int nIDButton, uint uCheck);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CheckDlgButton' -Namespace Win32 -PassThru
# $api::CheckDlgButton(hDlg, nIDButton, uCheck)
#uselib "USER32.dll"
#func global CheckDlgButton "CheckDlgButton" sptr, sptr, sptr
; CheckDlgButton hDlg, nIDButton, uCheck   ; 戻り値は stat
; hDlg : HWND -> "sptr"
; nIDButton : INT -> "sptr"
; uCheck : DLG_BUTTON_CHECK_STATE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global CheckDlgButton "CheckDlgButton" sptr, int, int
; res = CheckDlgButton(hDlg, nIDButton, uCheck)
; hDlg : HWND -> "sptr"
; nIDButton : INT -> "int"
; uCheck : DLG_BUTTON_CHECK_STATE -> "int"
; BOOL CheckDlgButton(HWND hDlg, INT nIDButton, DLG_BUTTON_CHECK_STATE uCheck)
#uselib "USER32.dll"
#cfunc global CheckDlgButton "CheckDlgButton" intptr, int, int
; res = CheckDlgButton(hDlg, nIDButton, uCheck)
; hDlg : HWND -> "intptr"
; nIDButton : INT -> "int"
; uCheck : DLG_BUTTON_CHECK_STATE -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procCheckDlgButton = user32.NewProc("CheckDlgButton")
)

// hDlg (HWND), nIDButton (INT), uCheck (DLG_BUTTON_CHECK_STATE)
r1, _, err := procCheckDlgButton.Call(
	uintptr(hDlg),
	uintptr(nIDButton),
	uintptr(uCheck),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CheckDlgButton(
  hDlg: THandle;   // HWND
  nIDButton: Integer;   // INT
  uCheck: DWORD   // DLG_BUTTON_CHECK_STATE
): BOOL; stdcall;
  external 'USER32.dll' name 'CheckDlgButton';
result := DllCall("USER32\CheckDlgButton"
    , "Ptr", hDlg   ; HWND
    , "Int", nIDButton   ; INT
    , "UInt", uCheck   ; DLG_BUTTON_CHECK_STATE
    , "Int")   ; return: BOOL
●CheckDlgButton(hDlg, nIDButton, uCheck) = DLL("USER32.dll", "bool CheckDlgButton(void*, int, dword)")
# 呼び出し: CheckDlgButton(hDlg, nIDButton, uCheck)
# hDlg : HWND -> "void*"
# nIDButton : INT -> "int"
# uCheck : DLG_BUTTON_CHECK_STATE -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn CheckDlgButton(
    hDlg: ?*anyopaque, // HWND
    nIDButton: i32, // INT
    uCheck: u32 // DLG_BUTTON_CHECK_STATE
) callconv(std.os.windows.WINAPI) i32;
proc CheckDlgButton(
    hDlg: pointer,  # HWND
    nIDButton: int32,  # INT
    uCheck: uint32  # DLG_BUTTON_CHECK_STATE
): int32 {.importc: "CheckDlgButton", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int CheckDlgButton(
    void* hDlg,   // HWND
    int nIDButton,   // INT
    uint uCheck   // DLG_BUTTON_CHECK_STATE
);
ccall((:CheckDlgButton, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, UInt32),
      hDlg, nIDButton, uCheck)
# hDlg : HWND -> Ptr{Cvoid}
# nIDButton : INT -> Int32
# uCheck : DLG_BUTTON_CHECK_STATE -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CheckDlgButton(
    void* hDlg,
    int32_t nIDButton,
    uint32_t uCheck);
]]
local user32 = ffi.load("user32")
-- user32.CheckDlgButton(hDlg, nIDButton, uCheck)
-- hDlg : HWND
-- nIDButton : INT
-- uCheck : DLG_BUTTON_CHECK_STATE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const CheckDlgButton = lib.func('__stdcall', 'CheckDlgButton', 'int32_t', ['void *', 'int32_t', 'uint32_t']);
// CheckDlgButton(hDlg, nIDButton, uCheck)
// hDlg : HWND -> 'void *'
// nIDButton : INT -> 'int32_t'
// uCheck : DLG_BUTTON_CHECK_STATE -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  CheckDlgButton: { parameters: ["pointer", "i32", "u32"], result: "i32" },
});
// lib.symbols.CheckDlgButton(hDlg, nIDButton, uCheck)
// hDlg : HWND -> "pointer"
// nIDButton : INT -> "i32"
// uCheck : DLG_BUTTON_CHECK_STATE -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CheckDlgButton(
    void* hDlg,
    int32_t nIDButton,
    uint32_t uCheck);
C, "USER32.dll");
// $ffi->CheckDlgButton(hDlg, nIDButton, uCheck);
// hDlg : HWND
// nIDButton : INT
// uCheck : DLG_BUTTON_CHECK_STATE
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    boolean CheckDlgButton(
        Pointer hDlg,   // HWND
        int nIDButton,   // INT
        int uCheck   // DLG_BUTTON_CHECK_STATE
    );
}
@[Link("user32")]
lib LibUSER32
  fun CheckDlgButton = CheckDlgButton(
    hDlg : Void*,   # HWND
    nIDButton : Int32,   # INT
    uCheck : UInt32   # DLG_BUTTON_CHECK_STATE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CheckDlgButtonNative = Int32 Function(Pointer<Void>, Int32, Uint32);
typedef CheckDlgButtonDart = int Function(Pointer<Void>, int, int);
final CheckDlgButton = DynamicLibrary.open('USER32.dll')
    .lookupFunction<CheckDlgButtonNative, CheckDlgButtonDart>('CheckDlgButton');
// hDlg : HWND -> Pointer<Void>
// nIDButton : INT -> Int32
// uCheck : DLG_BUTTON_CHECK_STATE -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CheckDlgButton(
  hDlg: THandle;   // HWND
  nIDButton: Integer;   // INT
  uCheck: DWORD   // DLG_BUTTON_CHECK_STATE
): BOOL; stdcall;
  external 'USER32.dll' name 'CheckDlgButton';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CheckDlgButton"
  c_CheckDlgButton :: Ptr () -> Int32 -> Word32 -> IO CInt
-- hDlg : HWND -> Ptr ()
-- nIDButton : INT -> Int32
-- uCheck : DLG_BUTTON_CHECK_STATE -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let checkdlgbutton =
  foreign "CheckDlgButton"
    ((ptr void) @-> int32_t @-> uint32_t @-> returning int32_t)
(* hDlg : HWND -> (ptr void) *)
(* nIDButton : INT -> int32_t *)
(* uCheck : DLG_BUTTON_CHECK_STATE -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("CheckDlgButton" check-dlg-button :convention :stdcall) :int32
  (h-dlg :pointer)   ; HWND
  (n-idbutton :int32)   ; INT
  (u-check :uint32))   ; DLG_BUTTON_CHECK_STATE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CheckDlgButton = Win32::API::More->new('USER32',
    'BOOL CheckDlgButton(HANDLE hDlg, int nIDButton, DWORD uCheck)');
# my $ret = $CheckDlgButton->Call($hDlg, $nIDButton, $uCheck);
# hDlg : HWND -> HANDLE
# nIDButton : INT -> int
# uCheck : DLG_BUTTON_CHECK_STATE -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型