ホーム › UI.WindowsAndMessaging › DialogBoxIndirectParamA

DialogBoxIndirectParamA

関数

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

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

シグネチャ

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

INT_PTR DialogBoxIndirectParamA(
    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

公式ドキュメント

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

戻り値

Type: INT_PTR

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

hWndParent パラメーターが無効なために関数が失敗した場合、戻り値はゼロです。この場合、関数は以前のバージョンの 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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DialogBoxIndirectParam を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不整合につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 DialogBoxIndirectParamA(
    HINSTANCE hInstance,   // optional
    DLGTEMPLATE* hDialogTemplate,
    HWND hWndParent,   // optional
    DLGPROC lpDialogFunc,   // optional
    LPARAM dwInitParam
);

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

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DialogBoxIndirectParamA(
    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 DialogBoxIndirectParamA Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal hDialogTemplate As LongPtr, _
    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

DialogBoxIndirectParamA = ctypes.windll.user32.DialogBoxIndirectParamA
DialogBoxIndirectParamA.restype = ctypes.c_ssize_t
DialogBoxIndirectParamA.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')
DialogBoxIndirectParamA = Fiddle::Function.new(
  lib['DialogBoxIndirectParamA'],
  [
    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)

#[link(name = "user32")]
extern "system" {
    fn DialogBoxIndirectParamA(
        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.Ansi, SetLastError = true)]
public static extern IntPtr DialogBoxIndirectParamA(IntPtr hInstance, IntPtr hDialogTemplate, IntPtr hWndParent, IntPtr lpDialogFunc, IntPtr dwInitParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DialogBoxIndirectParamA' -Namespace Win32 -PassThru
# $api::DialogBoxIndirectParamA(hInstance, hDialogTemplate, hWndParent, lpDialogFunc, dwInitParam)

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

出力引数:

#uselib "USER32.dll"
#cfunc global DialogBoxIndirectParamA "DialogBoxIndirectParamA" sptr, var, sptr, sptr, sptr
; res = DialogBoxIndirectParamA(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 DialogBoxIndirectParamA "DialogBoxIndirectParamA" sptr, sptr, sptr, sptr, sptr
; res = DialogBoxIndirectParamA(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(変数))。