DialogBoxParamA 関数 (winuser.h)

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

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

構文

INT_PTR DialogBoxParamA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpTemplateName,
  [in, optional] HWND      hWndParent,
  [in, optional] DLGPROC   lpDialogFunc,
  [in]           LPARAM    dwInitParam
);

パラメーター

[in, optional] hInstance

型: HINSTANCE

ダイアログボックステンプレートを含むモジュールのハンドル。このパラメーターが NULL の場合は、現在の実行可能ファイルが使用されます。

[in] lpTemplateName

型: LPCTSTR

ダイアログボックステンプレート。このパラメーターは、ダイアログボックステンプレートの名前を指定する null で終わる文字列へのポインターか、ダイアログボックステンプレートのリソース識別子を指定する整数値のいずれかです。パラメーターでリソース識別子を指定する場合、上位ワードは 0 で、下位ワードには識別子を含める必要があります。 MAKEINTRESOURCE マクロを使用して、この値を作成できます。

[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呼び出します。

備考

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

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

手記

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

必要条件

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

次の方法で共有

DialogBoxParamA 関数 (winuser.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース