DialogBoxIndirectParamA 関数 (winuser.h)

[アーティクル]
11/20/2024

メモリ内のダイアログボックステンプレートからモーダルダイアログボックスを作成します。この関数は、ダイアログボックスを表示する前に、WM_INITDIALOG メッセージの lParam パラメーターとして、アプリケーション定義の値をダイアログボックスプロシージャに渡します。アプリケーションでは、この値を使用してダイアログボックスコントロールを初期化できます。

構文

INT_PTR DialogBoxIndirectParamA(
  [in, optional] HINSTANCE       hInstance,
  [in]           LPCDLGTEMPLATEA hDialogTemplate,
  [in, optional] HWND            hWndParent,
  [in, optional] DLGPROC         lpDialogFunc,
  [in]           LPARAM          dwInitParam
);

パラメーター

[in, optional] hInstance

型: HINSTANCE

ダイアログボックスを作成するモジュールのハンドル。

[in] hDialogTemplate

型: LPCDLGTEMPLATE

DialogBoxIndirectParam テンプレートを使用してダイアログボックスを作成します。ダイアログボックステンプレートは、ダイアログボックスを記述するヘッダーの後に、ダイアログボックス内の各コントロールを記述する 1 つ以上の追加のデータブロックで構成されます。テンプレートでは、標準形式または拡張形式を使用できます。

ダイアログボックスの標準テンプレートでは、ヘッダーは DLGTEMPLATE 構造体の後に追加の可変長配列が続きます。各コントロールのデータは、DLGITEMTEMPLATE 構造体の後に、追加の可変長配列で構成されます。

ダイアログボックスの拡張テンプレートでは、ヘッダーは DLGTEMPLATEEX 形式を使用し、コントロール定義では DLGITEMTEMPLATEEX 形式を使用します。

[in, optional] hWndParent

型: HWND

ダイアログボックスを所有するウィンドウへのハンドル。

[in, optional] lpDialogFunc

型: DLGPROC

ダイアログボックスプロシージャへのポインター。ダイアログボックスプロシージャの詳細については、「DialogProcを参照してください。

[in] dwInitParam

型: LPARAM

WM_INITDIALOG メッセージの lParam パラメーターのダイアログボックスに渡す値。

戻り値

型: INT_PTR

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

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

備考

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

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

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

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

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

手記

winuser.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして DialogBoxIndirectParam を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	winuser.h (Windows.h を含む)
ライブラリ	User32.lib
DLL	User32.dll
API セットの	ext-ms-win-ntuser-dialogbox-l1-1-0 (Windows 8 で導入)

次の方法で共有

DialogBoxIndirectParamA 関数 (winuser.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース