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

DialogBoxParamW

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

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

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

パラメーター

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

戻り値の型: INT_PTR

公式ドキュメント

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

戻り値

型: INT_PTR

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

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

解説(Remarks)

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

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

メモ

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

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT_PTR DialogBoxParamW(
    HINSTANCE hInstance,   // optional
    LPCWSTR lpTemplateName,
    HWND hWndParent,   // optional
    DLGPROC lpDialogFunc,   // optional
    LPARAM dwInitParam
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr DialogBoxParamW(
    IntPtr hInstance,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpTemplateName,   // LPCWSTR
    IntPtr hWndParent,   // HWND optional
    IntPtr lpDialogFunc,   // DLGPROC optional
    IntPtr dwInitParam   // LPARAM
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DialogBoxParamW(
    hInstance As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPWStr)> lpTemplateName As String,   ' LPCWSTR
    hWndParent As IntPtr,   ' HWND optional
    lpDialogFunc As IntPtr,   ' DLGPROC optional
    dwInitParam As IntPtr   ' LPARAM
) As IntPtr
End Function
' hInstance : HINSTANCE optional
' lpTemplateName : LPCWSTR
' hWndParent : HWND optional
' lpDialogFunc : DLGPROC optional
' dwInitParam : LPARAM
Declare PtrSafe Function DialogBoxParamW Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpTemplateName As LongPtr, _
    ByVal hWndParent As LongPtr, _
    ByVal lpDialogFunc As LongPtr, _
    ByVal dwInitParam As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DialogBoxParamW = ctypes.windll.user32.DialogBoxParamW
DialogBoxParamW.restype = ctypes.c_ssize_t
DialogBoxParamW.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.LPCWSTR,  # lpTemplateName : LPCWSTR
    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')
DialogBoxParamW = Fiddle::Function.new(
  lib['DialogBoxParamW'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpTemplateName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # hWndParent : HWND optional
    Fiddle::TYPE_VOIDP,  # lpDialogFunc : DLGPROC optional
    Fiddle::TYPE_INTPTR_T,  # dwInitParam : LPARAM
  ],
  Fiddle::TYPE_INTPTR_T)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn DialogBoxParamW(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpTemplateName: *const u16,  // LPCWSTR
        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.Unicode, SetLastError = true)]
public static extern IntPtr DialogBoxParamW(IntPtr hInstance, [MarshalAs(UnmanagedType.LPWStr)] string lpTemplateName, IntPtr hWndParent, IntPtr lpDialogFunc, IntPtr dwInitParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DialogBoxParamW' -Namespace Win32 -PassThru
# $api::DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
#uselib "USER32.dll"
#func global DialogBoxParamW "DialogBoxParamW" wptr, wptr, wptr, wptr, wptr
; DialogBoxParamW hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "wptr"
; lpTemplateName : LPCWSTR -> "wptr"
; hWndParent : HWND optional -> "wptr"
; lpDialogFunc : DLGPROC optional -> "wptr"
; dwInitParam : LPARAM -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global DialogBoxParamW "DialogBoxParamW" sptr, wstr, sptr, sptr, sptr
; res = DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
; hInstance : HINSTANCE optional -> "sptr"
; lpTemplateName : LPCWSTR -> "wstr"
; hWndParent : HWND optional -> "sptr"
; lpDialogFunc : DLGPROC optional -> "sptr"
; dwInitParam : LPARAM -> "sptr"
; INT_PTR DialogBoxParamW(HINSTANCE hInstance, LPCWSTR lpTemplateName, HWND hWndParent, DLGPROC lpDialogFunc, LPARAM dwInitParam)
#uselib "USER32.dll"
#cfunc global DialogBoxParamW "DialogBoxParamW" intptr, wstr, intptr, intptr, intptr
; res = DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
; hInstance : HINSTANCE optional -> "intptr"
; lpTemplateName : LPCWSTR -> "wstr"
; hWndParent : HWND optional -> "intptr"
; lpDialogFunc : DLGPROC optional -> "intptr"
; dwInitParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procDialogBoxParamW = user32.NewProc("DialogBoxParamW")
)

// hInstance (HINSTANCE optional), lpTemplateName (LPCWSTR), hWndParent (HWND optional), lpDialogFunc (DLGPROC optional), dwInitParam (LPARAM)
r1, _, err := procDialogBoxParamW.Call(
	uintptr(hInstance),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpTemplateName))),
	uintptr(hWndParent),
	uintptr(lpDialogFunc),
	uintptr(dwInitParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT_PTR
function DialogBoxParamW(
  hInstance: THandle;   // HINSTANCE optional
  lpTemplateName: PWideChar;   // LPCWSTR
  hWndParent: THandle;   // HWND optional
  lpDialogFunc: Pointer;   // DLGPROC optional
  dwInitParam: NativeInt   // LPARAM
): NativeInt; stdcall;
  external 'USER32.dll' name 'DialogBoxParamW';
result := DllCall("USER32\DialogBoxParamW"
    , "Ptr", hInstance   ; HINSTANCE optional
    , "WStr", lpTemplateName   ; LPCWSTR
    , "Ptr", hWndParent   ; HWND optional
    , "Ptr", lpDialogFunc   ; DLGPROC optional
    , "Ptr", dwInitParam   ; LPARAM
    , "Ptr")   ; return: INT_PTR
●DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam) = DLL("USER32.dll", "int DialogBoxParamW(void*, char*, void*, void*, int)")
# 呼び出し: DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
# hInstance : HINSTANCE optional -> "void*"
# lpTemplateName : LPCWSTR -> "char*"
# hWndParent : HWND optional -> "void*"
# lpDialogFunc : DLGPROC optional -> "void*"
# dwInitParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn DialogBoxParamW(
    hInstance: ?*anyopaque, // HINSTANCE optional
    lpTemplateName: [*c]const u16, // LPCWSTR
    hWndParent: ?*anyopaque, // HWND optional
    lpDialogFunc: ?*anyopaque, // DLGPROC optional
    dwInitParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) isize;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DialogBoxParamW(
    hInstance: pointer,  # HINSTANCE optional
    lpTemplateName: WideCString,  # LPCWSTR
    hWndParent: pointer,  # HWND optional
    lpDialogFunc: pointer,  # DLGPROC optional
    dwInitParam: int  # LPARAM
): int {.importc: "DialogBoxParamW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
ptrdiff_t DialogBoxParamW(
    void* hInstance,   // HINSTANCE optional
    const(wchar)* lpTemplateName,   // LPCWSTR
    void* hWndParent,   // HWND optional
    void* lpDialogFunc,   // DLGPROC optional
    ptrdiff_t dwInitParam   // LPARAM
);
ccall((:DialogBoxParamW, "USER32.dll"), stdcall, Int,
      (Ptr{Cvoid}, Cwstring, Ptr{Cvoid}, Ptr{Cvoid}, Int),
      hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
# hInstance : HINSTANCE optional -> Ptr{Cvoid}
# lpTemplateName : LPCWSTR -> Cwstring
# hWndParent : HWND optional -> Ptr{Cvoid}
# lpDialogFunc : DLGPROC optional -> Ptr{Cvoid}
# dwInitParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
intptr_t DialogBoxParamW(
    void* hInstance,
    const uint16_t* lpTemplateName,
    void* hWndParent,
    void* lpDialogFunc,
    intptr_t dwInitParam);
]]
local user32 = ffi.load("user32")
-- user32.DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
-- hInstance : HINSTANCE optional
-- lpTemplateName : LPCWSTR
-- hWndParent : HWND optional
-- lpDialogFunc : DLGPROC optional
-- dwInitParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const DialogBoxParamW = lib.func('__stdcall', 'DialogBoxParamW', 'intptr_t', ['void *', 'str16', 'void *', 'void *', 'intptr_t']);
// DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
// hInstance : HINSTANCE optional -> 'void *'
// lpTemplateName : LPCWSTR -> 'str16'
// 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", {
  DialogBoxParamW: { parameters: ["pointer", "buffer", "pointer", "pointer", "isize"], result: "isize" },
});
// lib.symbols.DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam)
// hInstance : HINSTANCE optional -> "pointer"
// lpTemplateName : LPCWSTR -> "buffer"
// hWndParent : HWND optional -> "pointer"
// lpDialogFunc : DLGPROC optional -> "pointer"
// dwInitParam : LPARAM -> "isize"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
intptr_t DialogBoxParamW(
    void* hInstance,
    const uint16_t* lpTemplateName,
    void* hWndParent,
    void* lpDialogFunc,
    intptr_t dwInitParam);
C, "USER32.dll");
// $ffi->DialogBoxParamW(hInstance, lpTemplateName, hWndParent, lpDialogFunc, dwInitParam);
// hInstance : HINSTANCE optional
// lpTemplateName : LPCWSTR
// 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.UNICODE_OPTIONS);
    long DialogBoxParamW(
        Pointer hInstance,   // HINSTANCE optional
        WString lpTemplateName,   // LPCWSTR
        Pointer hWndParent,   // HWND optional
        Callback lpDialogFunc,   // DLGPROC optional
        long dwInitParam   // LPARAM
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun DialogBoxParamW = DialogBoxParamW(
    hInstance : Void*,   # HINSTANCE optional
    lpTemplateName : UInt16*,   # LPCWSTR
    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 DialogBoxParamWNative = IntPtr Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, IntPtr);
typedef DialogBoxParamWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, int);
final DialogBoxParamW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<DialogBoxParamWNative, DialogBoxParamWDart>('DialogBoxParamW');
// hInstance : HINSTANCE optional -> Pointer<Void>
// lpTemplateName : LPCWSTR -> Pointer<Utf16>
// hWndParent : HWND optional -> Pointer<Void>
// lpDialogFunc : DLGPROC optional -> Pointer<Void>
// dwInitParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DialogBoxParamW(
  hInstance: THandle;   // HINSTANCE optional
  lpTemplateName: PWideChar;   // LPCWSTR
  hWndParent: THandle;   // HWND optional
  lpDialogFunc: Pointer;   // DLGPROC optional
  dwInitParam: NativeInt   // LPARAM
): NativeInt; stdcall;
  external 'USER32.dll' name 'DialogBoxParamW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let dialogboxparamw =
  foreign "DialogBoxParamW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> intptr_t @-> returning intptr_t)
(* hInstance : HINSTANCE optional -> (ptr void) *)
(* lpTemplateName : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("DialogBoxParamW" dialog-box-param-w :convention :stdcall) :int64
  (h-instance :pointer)   ; HINSTANCE optional
  (lp-template-name (:string :encoding :utf-16le))   ; LPCWSTR
  (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 $DialogBoxParamW = Win32::API::More->new('USER32',
    'LPARAM DialogBoxParamW(HANDLE hInstance, LPCWSTR lpTemplateName, HANDLE hWndParent, LPVOID lpDialogFunc, LPARAM dwInitParam)');
# my $ret = $DialogBoxParamW->Call($hInstance, $lpTemplateName, $hWndParent, $lpDialogFunc, $dwInitParam);
# hInstance : HINSTANCE optional -> HANDLE
# lpTemplateName : LPCWSTR -> LPCWSTR
# hWndParent : HWND optional -> HANDLE
# lpDialogFunc : DLGPROC optional -> LPVOID
# dwInitParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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