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

IsDlgButtonChecked

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

シグネチャ

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

DWORD IsDlgButtonChecked(
    HWND hDlg,
    INT nIDButton
);

パラメーター

名前方向説明
hDlgHWNDinボタンコントロールを含むダイアログボックスへのハンドル。
nIDButtonINTinボタンコントロールの識別子。

戻り値の型: DWORD

公式ドキュメント

IsDlgButtonChecked 関数は、ボタンコントロールがチェックされているかどうか、または 3 状態ボタンコントロールがチェック済み・未チェック・不確定のいずれの状態であるかを判定します。

戻り値

型: UINT

BS_AUTOCHECKBOXBS_AUTORADIOBUTTONBS_AUTO3STATEBS_CHECKBOXBS_RADIOBUTTONBS_3STATE のいずれかのスタイルで作成されたボタンからの戻り値は、次の表のいずれかの値になります。ボタンがその他のスタイルの場合、戻り値は 0 です。

戻り値 説明
BST_CHECKED
ボタンはチェックされています。
BST_INDETERMINATE
ボタンは不確定状態です(ボタンが BS_3STATE または BS_AUTO3STATE スタイルを持つ場合にのみ適用されます)。
BST_UNCHECKED
ボタンはチェックされていません。

解説(Remarks)

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

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

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

各言語での呼び出し定義

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

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

IsDlgButtonChecked = ctypes.windll.user32.IsDlgButtonChecked
IsDlgButtonChecked.restype = wintypes.DWORD
IsDlgButtonChecked.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    ctypes.c_int,  # nIDButton : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procIsDlgButtonChecked = user32.NewProc("IsDlgButtonChecked")
)

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

extern "user32" fn IsDlgButtonChecked(
    hDlg: ?*anyopaque, // HWND
    nIDButton: i32 // INT
) callconv(std.os.windows.WINAPI) u32;
proc IsDlgButtonChecked(
    hDlg: pointer,  # HWND
    nIDButton: int32  # INT
): uint32 {.importc: "IsDlgButtonChecked", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
uint IsDlgButtonChecked(
    void* hDlg,   // HWND
    int nIDButton   // INT
);
ccall((:IsDlgButtonChecked, "USER32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Int32),
      hDlg, nIDButton)
# hDlg : HWND -> Ptr{Cvoid}
# nIDButton : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t IsDlgButtonChecked(
    void* hDlg,
    int32_t nIDButton);
]]
local user32 = ffi.load("user32")
-- user32.IsDlgButtonChecked(hDlg, nIDButton)
-- hDlg : HWND
-- nIDButton : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const IsDlgButtonChecked = lib.func('__stdcall', 'IsDlgButtonChecked', 'uint32_t', ['void *', 'int32_t']);
// IsDlgButtonChecked(hDlg, nIDButton)
// hDlg : HWND -> 'void *'
// nIDButton : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  IsDlgButtonChecked: { parameters: ["pointer", "i32"], result: "u32" },
});
// lib.symbols.IsDlgButtonChecked(hDlg, nIDButton)
// hDlg : HWND -> "pointer"
// nIDButton : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t IsDlgButtonChecked(
    void* hDlg,
    int32_t nIDButton);
C, "USER32.dll");
// $ffi->IsDlgButtonChecked(hDlg, nIDButton);
// hDlg : HWND
// nIDButton : INT
// 構造体/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);
    int IsDlgButtonChecked(
        Pointer hDlg,   // HWND
        int nIDButton   // INT
    );
}
@[Link("user32")]
lib LibUSER32
  fun IsDlgButtonChecked = IsDlgButtonChecked(
    hDlg : Void*,   # HWND
    nIDButton : Int32   # INT
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

公式の関連項目