ホーム › UI.WindowsAndMessaging › CreateDialogIndirectParamW

CreateDialogIndirectParamW

関数

メモリ上のテンプレートからモードレスダイアログを生成する(Unicode)。

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

シグネチャ

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

HWND CreateDialogIndirectParamW(
    HINSTANCE hInstance,   // optional
    DLGTEMPLATE* lpTemplate,
    HWND hWndParent,   // optional
    DLGPROC lpDialogFunc,   // optional
    LPARAM dwInitParam
);

パラメーター

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

戻り値の型: HWND

公式ドキュメント

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

戻り値

型: HWND

関数が成功した場合、戻り値はダイアログボックスのウィンドウハンドルです。

関数が失敗した場合、戻り値は NULL です。詳細なエラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

CreateDialogIndirectParam 関数は CreateWindowEx 関数を使用してダイアログボックスを作成します。その後、CreateDialogIndirectParam はダイアログボックスプロシージャに WM_INITDIALOG メッセージを送信します。テンプレートで DS_SETFONT または DS_SHELLFONT スタイルが指定されている場合、この関数はダイアログボックスプロシージャに WM_SETFONT メッセージも送信します。テンプレートで WS_VISIBLE スタイルが指定されている場合、この関数はダイアログボックスを表示します。最後に、CreateDialogIndirectParam はダイアログボックスのウィンドウハンドルを返します。

CreateDialogIndirectParam が戻った後、ShowWindow 関数を使用してダイアログボックスを表示できます(まだ表示されていない場合)。ダイアログボックスを破棄するには、DestroyWindow 関数を使用します。キーボードナビゲーションやその他のダイアログボックス機能をサポートするには、ダイアログボックスのメッセージループで IsDialogMessage 関数を呼び出す必要があります。

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

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

ダイアログボックステンプレート内のすべての文字列(ダイアログボックスやボタンのタイトルなど)は Unicode 文字列でなければなりません。

メモ

winuser.h ヘッダーは CreateDialogIndirectParam を、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>

HWND CreateDialogIndirectParamW(
    HINSTANCE hInstance,   // optional
    DLGTEMPLATE* lpTemplate,
    HWND hWndParent,   // optional
    DLGPROC lpDialogFunc,   // optional
    LPARAM dwInitParam
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateDialogIndirectParamW(
    IntPtr hInstance,   // HINSTANCE optional
    IntPtr lpTemplate,   // 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 CreateDialogIndirectParamW(
    hInstance As IntPtr,   ' HINSTANCE optional
    lpTemplate As IntPtr,   ' DLGTEMPLATE*
    hWndParent As IntPtr,   ' HWND optional
    lpDialogFunc As IntPtr,   ' DLGPROC optional
    dwInitParam As IntPtr   ' LPARAM
) As IntPtr
End Function

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

CreateDialogIndirectParamW = ctypes.windll.user32.CreateDialogIndirectParamW
CreateDialogIndirectParamW.restype = ctypes.c_void_p
CreateDialogIndirectParamW.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    ctypes.c_void_p,  # lpTemplate : 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')
CreateDialogIndirectParamW = Fiddle::Function.new(
  lib['CreateDialogIndirectParamW'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpTemplate : DLGTEMPLATE*
    Fiddle::TYPE_VOIDP,  # hWndParent : HWND optional
    Fiddle::TYPE_VOIDP,  # lpDialogFunc : DLGPROC optional
    Fiddle::TYPE_INTPTR_T,  # dwInitParam : LPARAM
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn CreateDialogIndirectParamW(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpTemplate: *mut DLGTEMPLATE,  // DLGTEMPLATE*
        hWndParent: *mut core::ffi::c_void,  // HWND optional
        lpDialogFunc: *const core::ffi::c_void,  // DLGPROC optional
        dwInitParam: isize  // LPARAM
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr CreateDialogIndirectParamW(IntPtr hInstance, IntPtr lpTemplate, IntPtr hWndParent, IntPtr lpDialogFunc, IntPtr dwInitParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CreateDialogIndirectParamW' -Namespace Win32 -PassThru
# $api::CreateDialogIndirectParamW(hInstance, lpTemplate, hWndParent, lpDialogFunc, dwInitParam)

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

出力引数:

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