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

TaskDialogIndirect

関数
構成構造体を指定してタスクダイアログを表示する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT TaskDialogIndirect(
    const TASKDIALOGCONFIG* pTaskConfig,
    INT* pnButton,   // optional
    INT* pnRadioButton,   // optional
    BOOL* pfVerificationFlagChecked   // optional
);

パラメーター

名前方向説明
pTaskConfigTASKDIALOGCONFIG*inタスクダイアログの表示に使用する情報を格納した TASKDIALOGCONFIG 構造体へのポインターです。
pnButtonINT*outoptional

次のいずれかを受け取る変数のアドレスです。

  • pTaskConfig パラメーターの pButtons メンバーで指定したボタン ID のいずれか
  • 次の値のいずれか:
説明
0 関数呼び出しが失敗しました。詳細については戻り値を参照してください。
IDCANCEL キャンセルボタンが選択された、Alt-F4 が押された、Escape が押された、またはユーザーがウィンドウを閉じるボタンをクリックしました。
IDNO いいえボタンが選択されました。
IDOK OK ボタンが選択されました。
IDRETRY 再試行ボタンが選択されました。
IDYES はいボタンが選択されました。

このパラメーターが NULL の場合、値は返されません。

pnRadioButtonINT*outoptionalpTaskConfig パラメーターの pRadioButtons メンバーで指定したボタン ID のいずれかを受け取る変数のアドレスです。このパラメーターが NULL の場合、値は返されません。
pfVerificationFlagCheckedBOOL*outoptional

次のいずれかの値を受け取る変数のアドレスです。

説明
TRUE ダイアログが閉じられたとき、確認チェックボックスがオンになっていました。
FALSE ダイアログが閉じられたとき、確認チェックボックスがオンになっていませんでした。

このパラメーターが NULL の場合、確認チェックボックスは無効化されます。

戻り値の型: HRESULT

公式ドキュメント

TaskDialogIndirect 関数は、タスクダイアログを作成、表示、操作します。

戻り値

型: HRESULT

この関数は次のいずれかの値を返します。

戻り値 説明
S_OK
操作が正常に完了しました。
E_OUTOFMEMORY
操作を完了するためのメモリが不足しています。
E_INVALIDARG
1 つ以上の引数が無効です。
E_FAIL
操作が失敗しました。

解説(Remarks)

システムのメモリが不足していることを示すためにタスクダイアログボックスを使用する場合、TASKDIALOGCONFIG 構造体内の各種文字列メンバーやアイコンメンバーが指す文字列は、リソースの読み込みに失敗する可能性があるため、リソースファイルから取得すべきではありません。

ダイアログボックスが表示されている状態でタスクダイアログを作成する場合は、そのダイアログボックスのハンドルを hWndParent パラメーターとして使用してください。hWndParent パラメーターには、ダイアログボックス内のコントロールのような子ウィンドウを指定すべきではありません。

この関数を呼び出す際、親ウィンドウは非表示や無効化された状態であってはなりません。


int nButtonPressed                  = 0;
TASKDIALOGCONFIG config             = {0};
const TASKDIALOG_BUTTON buttons[]   = { 
                                        { IDOK, L"Change password" }
                                      };
config.cbSize                       = sizeof(config);
config.hInstance                    = hInst;
config.dwCommonButtons              = TDCBF_CANCEL_BUTTON;
config.pszMainIcon                  = TD_WARNING_ICON;
config.pszMainInstruction           = L"Change Password";
config.pszContent                   = L"Remember your changed password.";
config.pButtons                     = buttons;
config.cButtons                     = ARRAYSIZE(buttons);

TaskDialogIndirect(&config, &nButtonPressed, NULL, NULL);
switch (nButtonPressed)
{
    case IDOK:
        break; // the user pressed button 0 (change password).
    case IDCANCEL:
        break; // user canceled the dialog
    default:
        break; // should never happen
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT TaskDialogIndirect(
    const TASKDIALOGCONFIG* pTaskConfig,
    INT* pnButton,   // optional
    INT* pnRadioButton,   // optional
    BOOL* pfVerificationFlagChecked   // optional
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int TaskDialogIndirect(
    IntPtr pTaskConfig,   // TASKDIALOGCONFIG*
    IntPtr pnButton,   // INT* optional, out
    IntPtr pnRadioButton,   // INT* optional, out
    IntPtr pfVerificationFlagChecked   // BOOL* optional, out
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function TaskDialogIndirect(
    pTaskConfig As IntPtr,   ' TASKDIALOGCONFIG*
    pnButton As IntPtr,   ' INT* optional, out
    pnRadioButton As IntPtr,   ' INT* optional, out
    pfVerificationFlagChecked As IntPtr   ' BOOL* optional, out
) As Integer
End Function
' pTaskConfig : TASKDIALOGCONFIG*
' pnButton : INT* optional, out
' pnRadioButton : INT* optional, out
' pfVerificationFlagChecked : BOOL* optional, out
Declare PtrSafe Function TaskDialogIndirect Lib "comctl32" ( _
    ByVal pTaskConfig As LongPtr, _
    ByVal pnButton As LongPtr, _
    ByVal pnRadioButton As LongPtr, _
    ByVal pfVerificationFlagChecked As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TaskDialogIndirect = ctypes.windll.comctl32.TaskDialogIndirect
TaskDialogIndirect.restype = ctypes.c_int
TaskDialogIndirect.argtypes = [
    ctypes.c_void_p,  # pTaskConfig : TASKDIALOGCONFIG*
    ctypes.POINTER(ctypes.c_int),  # pnButton : INT* optional, out
    ctypes.POINTER(ctypes.c_int),  # pnRadioButton : INT* optional, out
    ctypes.c_void_p,  # pfVerificationFlagChecked : BOOL* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
TaskDialogIndirect = Fiddle::Function.new(
  lib['TaskDialogIndirect'],
  [
    Fiddle::TYPE_VOIDP,  # pTaskConfig : TASKDIALOGCONFIG*
    Fiddle::TYPE_VOIDP,  # pnButton : INT* optional, out
    Fiddle::TYPE_VOIDP,  # pnRadioButton : INT* optional, out
    Fiddle::TYPE_VOIDP,  # pfVerificationFlagChecked : BOOL* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn TaskDialogIndirect(
        pTaskConfig: *const TASKDIALOGCONFIG,  // TASKDIALOGCONFIG*
        pnButton: *mut i32,  // INT* optional, out
        pnRadioButton: *mut i32,  // INT* optional, out
        pfVerificationFlagChecked: *mut i32  // BOOL* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("COMCTL32.dll")]
public static extern int TaskDialogIndirect(IntPtr pTaskConfig, IntPtr pnButton, IntPtr pnRadioButton, IntPtr pfVerificationFlagChecked);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_TaskDialogIndirect' -Namespace Win32 -PassThru
# $api::TaskDialogIndirect(pTaskConfig, pnButton, pnRadioButton, pfVerificationFlagChecked)
#uselib "COMCTL32.dll"
#func global TaskDialogIndirect "TaskDialogIndirect" sptr, sptr, sptr, sptr
; TaskDialogIndirect varptr(pTaskConfig), varptr(pnButton), varptr(pnRadioButton), varptr(pfVerificationFlagChecked)   ; 戻り値は stat
; pTaskConfig : TASKDIALOGCONFIG* -> "sptr"
; pnButton : INT* optional, out -> "sptr"
; pnRadioButton : INT* optional, out -> "sptr"
; pfVerificationFlagChecked : BOOL* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "COMCTL32.dll"
#cfunc global TaskDialogIndirect "TaskDialogIndirect" var, var, var, var
; res = TaskDialogIndirect(pTaskConfig, pnButton, pnRadioButton, pfVerificationFlagChecked)
; pTaskConfig : TASKDIALOGCONFIG* -> "var"
; pnButton : INT* optional, out -> "var"
; pnRadioButton : INT* optional, out -> "var"
; pfVerificationFlagChecked : BOOL* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT TaskDialogIndirect(TASKDIALOGCONFIG* pTaskConfig, INT* pnButton, INT* pnRadioButton, BOOL* pfVerificationFlagChecked)
#uselib "COMCTL32.dll"
#cfunc global TaskDialogIndirect "TaskDialogIndirect" var, var, var, var
; res = TaskDialogIndirect(pTaskConfig, pnButton, pnRadioButton, pfVerificationFlagChecked)
; pTaskConfig : TASKDIALOGCONFIG* -> "var"
; pnButton : INT* optional, out -> "var"
; pnRadioButton : INT* optional, out -> "var"
; pfVerificationFlagChecked : BOOL* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procTaskDialogIndirect = comctl32.NewProc("TaskDialogIndirect")
)

// pTaskConfig (TASKDIALOGCONFIG*), pnButton (INT* optional, out), pnRadioButton (INT* optional, out), pfVerificationFlagChecked (BOOL* optional, out)
r1, _, err := procTaskDialogIndirect.Call(
	uintptr(pTaskConfig),
	uintptr(pnButton),
	uintptr(pnRadioButton),
	uintptr(pfVerificationFlagChecked),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function TaskDialogIndirect(
  pTaskConfig: Pointer;   // TASKDIALOGCONFIG*
  pnButton: Pointer;   // INT* optional, out
  pnRadioButton: Pointer;   // INT* optional, out
  pfVerificationFlagChecked: Pointer   // BOOL* optional, out
): Integer; stdcall;
  external 'COMCTL32.dll' name 'TaskDialogIndirect';
result := DllCall("COMCTL32\TaskDialogIndirect"
    , "Ptr", pTaskConfig   ; TASKDIALOGCONFIG*
    , "Ptr", pnButton   ; INT* optional, out
    , "Ptr", pnRadioButton   ; INT* optional, out
    , "Ptr", pfVerificationFlagChecked   ; BOOL* optional, out
    , "Int")   ; return: HRESULT
●TaskDialogIndirect(pTaskConfig, pnButton, pnRadioButton, pfVerificationFlagChecked) = DLL("COMCTL32.dll", "int TaskDialogIndirect(void*, void*, void*, void*)")
# 呼び出し: TaskDialogIndirect(pTaskConfig, pnButton, pnRadioButton, pfVerificationFlagChecked)
# pTaskConfig : TASKDIALOGCONFIG* -> "void*"
# pnButton : INT* optional, out -> "void*"
# pnRadioButton : INT* optional, out -> "void*"
# pfVerificationFlagChecked : BOOL* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef TaskDialogIndirectNative = Int32 Function(Pointer<Void>, Pointer<Int32>, Pointer<Int32>, Pointer<Int32>);
typedef TaskDialogIndirectDart = int Function(Pointer<Void>, Pointer<Int32>, Pointer<Int32>, Pointer<Int32>);
final TaskDialogIndirect = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<TaskDialogIndirectNative, TaskDialogIndirectDart>('TaskDialogIndirect');
// pTaskConfig : TASKDIALOGCONFIG* -> Pointer<Void>
// pnButton : INT* optional, out -> Pointer<Int32>
// pnRadioButton : INT* optional, out -> Pointer<Int32>
// pfVerificationFlagChecked : BOOL* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TaskDialogIndirect(
  pTaskConfig: Pointer;   // TASKDIALOGCONFIG*
  pnButton: Pointer;   // INT* optional, out
  pnRadioButton: Pointer;   // INT* optional, out
  pfVerificationFlagChecked: Pointer   // BOOL* optional, out
): Integer; stdcall;
  external 'COMCTL32.dll' name 'TaskDialogIndirect';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TaskDialogIndirect"
  c_TaskDialogIndirect :: Ptr () -> Ptr Int32 -> Ptr Int32 -> Ptr CInt -> IO Int32
-- pTaskConfig : TASKDIALOGCONFIG* -> Ptr ()
-- pnButton : INT* optional, out -> Ptr Int32
-- pnRadioButton : INT* optional, out -> Ptr Int32
-- pfVerificationFlagChecked : BOOL* optional, out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let taskdialogindirect =
  foreign "TaskDialogIndirect"
    ((ptr void) @-> (ptr int32_t) @-> (ptr int32_t) @-> (ptr int32_t) @-> returning int32_t)
(* pTaskConfig : TASKDIALOGCONFIG* -> (ptr void) *)
(* pnButton : INT* optional, out -> (ptr int32_t) *)
(* pnRadioButton : INT* optional, out -> (ptr int32_t) *)
(* pfVerificationFlagChecked : BOOL* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("TaskDialogIndirect" task-dialog-indirect :convention :stdcall) :int32
  (p-task-config :pointer)   ; TASKDIALOGCONFIG*
  (pn-button :pointer)   ; INT* optional, out
  (pn-radio-button :pointer)   ; INT* optional, out
  (pf-verification-flag-checked :pointer))   ; BOOL* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TaskDialogIndirect = Win32::API::More->new('COMCTL32',
    'int TaskDialogIndirect(LPVOID pTaskConfig, LPVOID pnButton, LPVOID pnRadioButton, LPVOID pfVerificationFlagChecked)');
# my $ret = $TaskDialogIndirect->Call($pTaskConfig, $pnButton, $pnRadioButton, $pfVerificationFlagChecked);
# pTaskConfig : TASKDIALOGCONFIG* -> LPVOID
# pnButton : INT* optional, out -> LPVOID
# pnRadioButton : INT* optional, out -> LPVOID
# pfVerificationFlagChecked : BOOL* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型