ホーム › UI.WindowsAndMessaging › DialogBoxIndirectParamW

DialogBoxIndirectParamW

関数

メモリ上テンプレートからモーダルダイアログを実行する(Unicode)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT_PTR DialogBoxIndirectParamW(
    HINSTANCE hInstance,   // optional
    DLGTEMPLATE* hDialogTemplate,
    HWND hWndParent,   // optional
    DLGPROC lpDialogFunc,   // optional
    LPARAM dwInitParam
);

パラメーター

名前	型	方向	説明
hInstance	HINSTANCE	inoptional	ダイアログボックスを作成するモジュールへのハンドルです。
hDialogTemplate	DLGTEMPLATE*	in	DialogBoxIndirectParam がダイアログボックスの作成に使用するテンプレートです。ダイアログボックステンプレートは、ダイアログボックスを記述するヘッダーと、それに続く 1 つ以上の追加データブロック(ダイアログボックス内の各コントロールを記述する)で構成されます。テンプレートには標準フォーマットまたは拡張フォーマットのいずれかを使用できます。ダイアログボックスの標準テンプレートでは、ヘッダーは DLGTEMPLATE 構造体に続いて追加の可変長配列が並びます。各コントロールのデータは、DLGITEMTEMPLATE 構造体に続いて追加の可変長配列が並びます。ダイアログボックスの拡張テンプレートでは、ヘッダーに DLGTEMPLATEEX フォーマットを使用し、コントロール定義には DLGITEMTEMPLATEEX フォーマットを使用します。
hWndParent	HWND	inoptional	ダイアログボックスを所有するウィンドウへのハンドルです。
lpDialogFunc	DLGPROC	inoptional	ダイアログボックスプロシージャへのポインターです。ダイアログボックスプロシージャの詳細については、DialogProc を参照してください。
dwInitParam	LPARAM	in	WM_INITDIALOG メッセージの lParam パラメーターでダイアログボックスに渡す値です。

戻り値の型: INT_PTR

公式ドキュメント

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

戻り値

型: INT_PTR

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

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

解説(Remarks)

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

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

標準ダイアログボックステンプレートでは、DLGTEMPLATE 構造体および各 DLGITEMTEMPLATE 構造体は DWORD 境界に整列する必要があります。DLGITEMTEMPLATE 構造体に続く作成データ配列も DWORD 境界に整列する必要があります。テンプレート内のその他のすべての可変長配列は WORD 境界に整列する必要があります。

拡張ダイアログボックステンプレートでは、DLGTEMPLATEEX ヘッダーおよび各 DLGITEMTEMPLATEEX コントロール定義は DWORD 境界に整列する必要があります。DLGITEMTEMPLATEEX 構造体に続く作成データ配列(存在する場合)も DWORD 境界に整列する必要があります。テンプレート内のその他のすべての可変長配列は WORD 境界に整列する必要があります。

ダイアログボックステンプレート内のすべての文字列(ダイアログボックスやボタンのタイトルなど)は Unicode 文字列である必要があります。

メモ

winuser.h ヘッダーは DialogBoxIndirectParam を、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 DialogBoxIndirectParamW(
    HINSTANCE hInstance,   // optional
    DLGTEMPLATE* hDialogTemplate,
    HWND hWndParent,   // optional
    DLGPROC lpDialogFunc,   // optional
    LPARAM dwInitParam
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr DialogBoxIndirectParamW(
    IntPtr hInstance,   // HINSTANCE optional
    IntPtr hDialogTemplate,   // DLGTEMPLATE*
    IntPtr hWndParent,   // HWND optional
    IntPtr lpDialogFunc,   // DLGPROC optional
    IntPtr dwInitParam   // LPARAM
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DialogBoxIndirectParamW(
    hInstance As IntPtr,   ' HINSTANCE optional
    hDialogTemplate As IntPtr,   ' DLGTEMPLATE*
    hWndParent As IntPtr,   ' HWND optional
    lpDialogFunc As IntPtr,   ' DLGPROC optional
    dwInitParam As IntPtr   ' LPARAM
) As IntPtr
End Function

' hInstance : HINSTANCE optional
' hDialogTemplate : DLGTEMPLATE*
' hWndParent : HWND optional
' lpDialogFunc : DLGPROC optional
' dwInitParam : LPARAM
Declare PtrSafe Function DialogBoxIndirectParamW Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal hDialogTemplate 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

DialogBoxIndirectParamW = ctypes.windll.user32.DialogBoxIndirectParamW
DialogBoxIndirectParamW.restype = ctypes.c_ssize_t
DialogBoxIndirectParamW.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    ctypes.c_void_p,  # hDialogTemplate : DLGTEMPLATE*
    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')
DialogBoxIndirectParamW = Fiddle::Function.new(
  lib['DialogBoxIndirectParamW'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # hDialogTemplate : DLGTEMPLATE*
    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 DialogBoxIndirectParamW(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        hDialogTemplate: *mut DLGTEMPLATE,  // DLGTEMPLATE*
        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 DialogBoxIndirectParamW(IntPtr hInstance, IntPtr hDialogTemplate, IntPtr hWndParent, IntPtr lpDialogFunc, IntPtr dwInitParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DialogBoxIndirectParamW' -Namespace Win32 -PassThru
# $api::DialogBoxIndirectParamW(hInstance, hDialogTemplate, hWndParent, lpDialogFunc, dwInitParam)

#uselib "USER32.dll"
#func global DialogBoxIndirectParamW "DialogBoxIndirectParamW" wptr, wptr, wptr, wptr, wptr
; DialogBoxIndirectParamW hInstance, varptr(hDialogTemplate), hWndParent, lpDialogFunc, dwInitParam   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "wptr"
; hDialogTemplate : DLGTEMPLATE* -> "wptr"
; hWndParent : HWND optional -> "wptr"
; lpDialogFunc : DLGPROC optional -> "wptr"
; dwInitParam : LPARAM -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DialogBoxIndirectParamW "DialogBoxIndirectParamW" sptr, var, sptr, sptr, sptr
; res = DialogBoxIndirectParamW(hInstance, hDialogTemplate, hWndParent, lpDialogFunc, dwInitParam)
; hInstance : HINSTANCE optional -> "sptr"
; hDialogTemplate : DLGTEMPLATE* -> "var"
; hWndParent : HWND optional -> "sptr"
; lpDialogFunc : DLGPROC optional -> "sptr"
; dwInitParam : LPARAM -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DialogBoxIndirectParamW "DialogBoxIndirectParamW" sptr, sptr, sptr, sptr, sptr
; res = DialogBoxIndirectParamW(hInstance, varptr(hDialogTemplate), hWndParent, lpDialogFunc, dwInitParam)
; hInstance : HINSTANCE optional -> "sptr"
; hDialogTemplate : DLGTEMPLATE* -> "sptr"
; hWndParent : HWND optional -> "sptr"
; lpDialogFunc : DLGPROC optional -> "sptr"
; dwInitParam : LPARAM -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。