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

DialogBoxParamA

関数
モーダルダイアログを生成し終了まで実行する(ANSI)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT_PTR DialogBoxParamA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpTemplateName,
    HWND hWndParent,   // optional
    DLGPROC lpDialogFunc,   // optional
    LPARAM dwInitParam
);

パラメーター

名前方向説明
hInstanceHINSTANCEinoptionalダイアログボックステンプレートを含むモジュールへのハンドル。このパラメーターが NULL の場合、現在の実行可能ファイルが使用されます。
lpTemplateNameLPCSTRinダイアログボックステンプレート。このパラメーターには、ダイアログボックステンプレートの名前を指定する null 終端文字列へのポインター、またはダイアログボックステンプレートのリソース識別子を指定する整数値のいずれかを指定します。リソース識別子を指定する場合、上位ワードは 0、下位ワードは識別子を含む必要があります。この値の作成には MAKEINTRESOURCE マクロを使用できます。
hWndParentHWNDinoptionalダイアログボックスを所有するウィンドウへのハンドル。
lpDialogFuncDLGPROCinoptionalダイアログボックスプロシージャへのポインター。ダイアログボックスプロシージャの詳細については、DialogProc を参照してください。
dwInitParamLPARAMinWM_INITDIALOG メッセージの lParam パラメーターでダイアログボックスに渡す値。

戻り値の型: INT_PTR

公式ドキュメント

ダイアログボックステンプレートリソースからモーダルダイアログボックスを作成します。(ANSI)

戻り値

型: INT_PTR

関数が成功した場合、戻り値はダイアログボックスを終了するために使用された EndDialog 関数の呼び出しで指定された nResult パラメーターの値です。

hWndParent パラメーターが無効であるために関数が失敗した場合、戻り値は 0 です。この場合、関数は以前のバージョンの Windows との互換性のために 0 を返します。それ以外の理由で関数が失敗した場合、戻り値は -1 です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

DialogBoxParam 関数は、CreateWindowEx 関数を使用してダイアログボックスを作成します。続いて DialogBoxParam は、WM_INITDIALOG メッセージ(テンプレートが DS_SETFONT または DS_SHELLFONT スタイルを指定している場合は WM_SETFONT メッセージも)をダイアログボックスプロシージャに送信します。この関数は(テンプレートが WS_VISIBLE スタイルを指定しているかどうかにかかわらず)ダイアログボックスを表示し、所有元ウィンドウを無効化し、ダイアログボックスのメッセージを取得してディスパッチするために独自のメッセージループを開始します。

ダイアログボックスプロシージャが EndDialog 関数を呼び出すと、DialogBoxParam はダイアログボックスを破棄し、メッセージループを終了し、(以前に有効化されていた場合は)所有元ウィンドウを有効化し、ダイアログボックスプロシージャが EndDialog を呼び出した際に指定した nResult パラメーターを返します。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DialogBoxParam を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT_PTR DialogBoxParamA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpTemplateName,
    HWND hWndParent,   // optional
    DLGPROC lpDialogFunc,   // optional
    LPARAM dwInitParam
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr DialogBoxParamA(
    IntPtr hInstance,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPStr)] string lpTemplateName,   // LPCSTR
    IntPtr hWndParent,   // HWND optional
    IntPtr lpDialogFunc,   // DLGPROC optional
    IntPtr dwInitParam   // LPARAM
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DialogBoxParamA(
    hInstance As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPStr)> lpTemplateName As String,   ' LPCSTR
    hWndParent As IntPtr,   ' HWND optional
    lpDialogFunc As IntPtr,   ' DLGPROC optional
    dwInitParam As IntPtr   ' LPARAM
) As IntPtr
End Function
' hInstance : HINSTANCE optional
' lpTemplateName : LPCSTR
' hWndParent : HWND optional
' lpDialogFunc : DLGPROC optional
' dwInitParam : LPARAM
Declare PtrSafe Function DialogBoxParamA Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpTemplateName As String, _
    ByVal hWndParent As LongPtr, _
    ByVal lpDialogFunc As LongPtr, _
    ByVal dwInitParam As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DialogBoxParamA = ctypes.windll.user32.DialogBoxParamA
DialogBoxParamA.restype = ctypes.c_ssize_t
DialogBoxParamA.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.LPCSTR,  # lpTemplateName : LPCSTR
    wintypes.HANDLE,  # hWndParent : HWND optional
    ctypes.c_void_p,  # lpDialogFunc : DLGPROC optional
    ctypes.c_ssize_t,  # dwInitParam : LPARAM
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DialogBoxParamA = Fiddle::Function.new(
  lib['DialogBoxParamA'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpTemplateName : LPCSTR
    Fiddle::TYPE_VOIDP,  # hWndParent : HWND optional
    Fiddle::TYPE_VOIDP,  # lpDialogFunc : DLGPROC optional
    Fiddle::TYPE_INTPTR_T,  # dwInitParam : LPARAM
  ],
  Fiddle::TYPE_INTPTR_T)
#[link(name = "user32")]
extern "system" {
    fn DialogBoxParamA(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpTemplateName: *const u8,  // LPCSTR
        hWndParent: *mut core::ffi::c_void,  // HWND optional
        lpDialogFunc: *const core::ffi::c_void,  // DLGPROC optional
        dwInitParam: isize  // LPARAM
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr DialogBoxParamA(IntPtr hInstance, [MarshalAs(UnmanagedType.LPStr)] string lpTemplateName, IntPtr hWndParent, IntPtr lpDialogFunc, IntPtr dwInitParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DialogBoxParamA' -Namespace Win32 -PassThru
# $api::DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
#uselib "USER32.dll"
#func global DialogBoxParamA "DialogBoxParamA" sptr, sptr, sptr, sptr, sptr
; DialogBoxParamA hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "sptr"
; lpTemplateName : LPCSTR -> "sptr"
; hWndParent : HWND optional -> "sptr"
; lpDialogFunc : DLGPROC optional -> "sptr"
; dwInitParam : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global DialogBoxParamA "DialogBoxParamA" sptr, str, sptr, sptr, sptr
; res = DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
; hInstance : HINSTANCE optional -> "sptr"
; lpTemplateName : LPCSTR -> "str"
; hWndParent : HWND optional -> "sptr"
; lpDialogFunc : DLGPROC optional -> "sptr"
; dwInitParam : LPARAM -> "sptr"
; INT_PTR DialogBoxParamA(HINSTANCE hInstance, LPCSTR lpTemplateName, HWND hWndParent, DLGPROC lpDialogFunc, LPARAM dwInitParam)
#uselib "USER32.dll"
#cfunc global DialogBoxParamA "DialogBoxParamA" intptr, str, intptr, intptr, intptr
; res = DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
; hInstance : HINSTANCE optional -> "intptr"
; lpTemplateName : LPCSTR -> "str"
; hWndParent : HWND optional -> "intptr"
; lpDialogFunc : DLGPROC optional -> "intptr"
; dwInitParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDialogBoxParamA = user32.NewProc("DialogBoxParamA")
)

// hInstance (HINSTANCE optional), lpTemplateName (LPCSTR), hWndParent (HWND optional), lpDialogFunc (DLGPROC optional), dwInitParam (LPARAM)
r1, _, err := procDialogBoxParamA.Call(
	uintptr(hInstance),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpTemplateName))),
	uintptr(hWndParent),
	uintptr(lpDialogFunc),
	uintptr(dwInitParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT_PTR
function DialogBoxParamA(
  hInstance: THandle;   // HINSTANCE optional
  lpTemplateName: PAnsiChar;   // LPCSTR
  hWndParent: THandle;   // HWND optional
  lpDialogFunc: Pointer;   // DLGPROC optional
  dwInitParam: NativeInt   // LPARAM
): NativeInt; stdcall;
  external 'USER32.dll' name 'DialogBoxParamA';
result := DllCall("USER32\DialogBoxParamA"
    , "Ptr", hInstance   ; HINSTANCE optional
    , "AStr", lpTemplateName   ; LPCSTR
    , "Ptr", hWndParent   ; HWND optional
    , "Ptr", lpDialogFunc   ; DLGPROC optional
    , "Ptr", dwInitParam   ; LPARAM
    , "Ptr")   ; return: INT_PTR
●DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam) = DLL("USER32.dll", "int DialogBoxParamA(void*, char*, void*, void*, int)")
# 呼び出し: DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
# hInstance : HINSTANCE optional -> "void*"
# lpTemplateName : LPCSTR -> "char*"
# hWndParent : HWND optional -> "void*"
# lpDialogFunc : DLGPROC optional -> "void*"
# dwInitParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn DialogBoxParamA(
    hInstance: ?*anyopaque, // HINSTANCE optional
    lpTemplateName: [*c]const u8, // LPCSTR
    hWndParent: ?*anyopaque, // HWND optional
    lpDialogFunc: ?*anyopaque, // DLGPROC optional
    dwInitParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) isize;
proc DialogBoxParamA(
    hInstance: pointer,  # HINSTANCE optional
    lpTemplateName: cstring,  # LPCSTR
    hWndParent: pointer,  # HWND optional
    lpDialogFunc: pointer,  # DLGPROC optional
    dwInitParam: int  # LPARAM
): int {.importc: "DialogBoxParamA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
ptrdiff_t DialogBoxParamA(
    void* hInstance,   // HINSTANCE optional
    const(char)* lpTemplateName,   // LPCSTR
    void* hWndParent,   // HWND optional
    void* lpDialogFunc,   // DLGPROC optional
    ptrdiff_t dwInitParam   // LPARAM
);
ccall((:DialogBoxParamA, "USER32.dll"), stdcall, Int,
      (Ptr{Cvoid}, Cstring, Ptr{Cvoid}, Ptr{Cvoid}, Int),
      hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
# hInstance : HINSTANCE optional -> Ptr{Cvoid}
# lpTemplateName : LPCSTR -> Cstring
# hWndParent : HWND optional -> Ptr{Cvoid}
# lpDialogFunc : DLGPROC optional -> Ptr{Cvoid}
# dwInitParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
intptr_t DialogBoxParamA(
    void* hInstance,
    const char* lpTemplateName,
    void* hWndParent,
    void* lpDialogFunc,
    intptr_t dwInitParam);
]]
local user32 = ffi.load("user32")
-- user32.DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
-- hInstance : HINSTANCE optional
-- lpTemplateName : LPCSTR
-- hWndParent : HWND optional
-- lpDialogFunc : DLGPROC optional
-- dwInitParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const DialogBoxParamA = lib.func('__stdcall', 'DialogBoxParamA', 'intptr_t', ['void *', 'str', 'void *', 'void *', 'intptr_t']);
// DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
// hInstance : HINSTANCE optional -> 'void *'
// lpTemplateName : LPCSTR -> 'str'
// hWndParent : HWND optional -> 'void *'
// lpDialogFunc : DLGPROC optional -> 'void *'
// dwInitParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("USER32.dll", {
  DialogBoxParamA: { parameters: ["pointer", "buffer", "pointer", "pointer", "isize"], result: "isize" },
});
// lib.symbols.DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
// hInstance : HINSTANCE optional -> "pointer"
// lpTemplateName : LPCSTR -> "buffer"
// hWndParent : HWND optional -> "pointer"
// lpDialogFunc : DLGPROC optional -> "pointer"
// dwInitParam : LPARAM -> "isize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t DialogBoxParamA(
    void* hInstance,
    const char* lpTemplateName,
    void* hWndParent,
    void* lpDialogFunc,
    intptr_t dwInitParam);
C, "USER32.dll");
// $ffi->DialogBoxParamA(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam);
// hInstance : HINSTANCE optional
// lpTemplateName : LPCSTR
// hWndParent : HWND optional
// lpDialogFunc : DLGPROC optional
// dwInitParam : LPARAM
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    long DialogBoxParamA(
        Pointer hInstance,   // HINSTANCE optional
        String lpTemplateName,   // LPCSTR
        Pointer hWndParent,   // HWND optional
        Callback lpDialogFunc,   // DLGPROC optional
        long dwInitParam   // LPARAM
    );
}
@[Link("user32")]
lib LibUSER32
  fun DialogBoxParamA = DialogBoxParamA(
    hInstance : Void*,   # HINSTANCE optional
    lpTemplateName : UInt8*,   # LPCSTR
    hWndParent : Void*,   # HWND optional
    lpDialogFunc : Void*,   # DLGPROC optional
    dwInitParam : LibC::SSizeT   # LPARAM
  ) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DialogBoxParamANative = IntPtr Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>, Pointer<Void>, IntPtr);
typedef DialogBoxParamADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>, Pointer<Void>, int);
final DialogBoxParamA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<DialogBoxParamANative, DialogBoxParamADart>('DialogBoxParamA');
// hInstance : HINSTANCE optional -> Pointer<Void>
// lpTemplateName : LPCSTR -> Pointer<Utf8>
// hWndParent : HWND optional -> Pointer<Void>
// lpDialogFunc : DLGPROC optional -> Pointer<Void>
// dwInitParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DialogBoxParamA(
  hInstance: THandle;   // HINSTANCE optional
  lpTemplateName: PAnsiChar;   // LPCSTR
  hWndParent: THandle;   // HWND optional
  lpDialogFunc: Pointer;   // DLGPROC optional
  dwInitParam: NativeInt   // LPARAM
): NativeInt; stdcall;
  external 'USER32.dll' name 'DialogBoxParamA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DialogBoxParamA"
  c_DialogBoxParamA :: Ptr () -> CString -> Ptr () -> Ptr () -> CIntPtr -> IO CIntPtr
-- hInstance : HINSTANCE optional -> Ptr ()
-- lpTemplateName : LPCSTR -> CString
-- hWndParent : HWND optional -> Ptr ()
-- lpDialogFunc : DLGPROC optional -> Ptr ()
-- dwInitParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dialogboxparama =
  foreign "DialogBoxParamA"
    ((ptr void) @-> string @-> (ptr void) @-> (ptr void) @-> intptr_t @-> returning intptr_t)
(* hInstance : HINSTANCE optional -> (ptr void) *)
(* lpTemplateName : LPCSTR -> string *)
(* hWndParent : HWND optional -> (ptr void) *)
(* lpDialogFunc : DLGPROC optional -> (ptr void) *)
(* dwInitParam : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("DialogBoxParamA" dialog-box-param-a :convention :stdcall) :int64
  (h-instance :pointer)   ; HINSTANCE optional
  (lp-template-name :string)   ; LPCSTR
  (h-wnd-parent :pointer)   ; HWND optional
  (lp-dialog-func :pointer)   ; DLGPROC optional
  (dw-init-param :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DialogBoxParamA = Win32::API::More->new('USER32',
    'LPARAM DialogBoxParamA(HANDLE hInstance, LPCSTR lpTemplateName, HANDLE hWndParent, LPVOID lpDialogFunc, LPARAM dwInitParam)');
# my $ret = $DialogBoxParamA->Call($hInstance, $lpTemplateName, $hWndParent, $lpDialogFunc, $dwInitParam);
# hInstance : HINSTANCE optional -> HANDLE
# lpTemplateName : LPCSTR -> LPCSTR
# hWndParent : HWND optional -> HANDLE
# lpDialogFunc : DLGPROC optional -> LPVOID
# dwInitParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

文字セット違い
公式の関連項目
使用する型