Fungsi DialogBoxParamA (winuser.h)

Artikel
08/27/2023

Membuat kotak dialog modal dari sumber daya templat kotak dialog. Sebelum menampilkan kotak dialog, fungsi meneruskan nilai yang ditentukan aplikasi ke prosedur kotak dialog sebagai parameter lParam dari pesan WM_INITDIALOG . Aplikasi dapat menggunakan nilai ini untuk menginisialisasi kontrol kotak dialog.

Sintaks

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

Parameter

[in, optional] hInstance

Jenis: HINSTANCE

Handel ke modul yang berisi templat kotak dialog. Jika parameter ini ADALAH NULL, maka executable saat ini digunakan.

[in] lpTemplateName

Jenis: LPCTSTR

Templat kotak dialog. Parameter ini adalah penunjuk ke string karakter yang dihentikan null yang menentukan nama templat kotak dialog atau nilai bilangan bulat yang menentukan pengidentifikasi sumber daya templat kotak dialog. Jika parameter menentukan pengidentifikasi sumber daya, kata urutan tingginya harus nol dan kata urutan rendahnya harus berisi pengidentifikasi. Anda dapat menggunakan makro MAKEINTRESOURCE untuk membuat nilai ini.

[in, optional] hWndParent

Jenis: HWND

Handel ke jendela yang memiliki kotak dialog.

[in, optional] lpDialogFunc

Jenis: DLGPROC

Penunjuk ke prosedur kotak dialog. Untuk informasi selengkapnya tentang prosedur kotak dialog, lihat DialogProc.

[in] dwInitParam

Jenis: LPARAM

Nilai yang akan diteruskan ke kotak dialog di parameter lParam dari pesan WM_INITDIALOG .

Nilai kembali

Jenis: INT_PTR

Jika fungsi berhasil, nilai yang dikembalikan adalah nilai parameter nResult yang ditentukan dalam panggilan ke fungsi EndDialog yang digunakan untuk mengakhiri kotak dialog.

Jika fungsi gagal karena parameter hWndParent tidak valid, nilai yang dikembalikan adalah nol. Fungsi mengembalikan nol dalam hal ini untuk kompatibilitas dengan versi Windows sebelumnya. Jika fungsi gagal karena alasan lain, nilai yang dikembalikan adalah –1. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Fungsi DialogBoxParam menggunakan fungsi CreateWindowEx untuk membuat kotak dialog. DialogBoxParam kemudian mengirim pesan WM_INITDIALOG (dan pesan WM_SETFONT jika templat menentukan gaya DS_SETFONT atau DS_SHELLFONT) ke prosedur kotak dialog. Fungsi menampilkan kotak dialog (terlepas dari apakah templat menentukan gaya WS_VISIBLE ), menonaktifkan jendela pemilik, dan memulai perulangan pesannya sendiri untuk mengambil dan mengirim pesan untuk kotak dialog.

Saat prosedur kotak dialog memanggil fungsi EndDialog , DialogBoxParam menghancurkan kotak dialog, mengakhiri perulangan pesan, mengaktifkan jendela pemilik (jika sebelumnya diaktifkan), dan mengembalikan parameter nResult yang ditentukan oleh prosedur kotak dialog saat disebut EndDialog.

Catatan

Header winuser.h mendefinisikan DialogBoxParam sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta pra-prosesor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	winuser.h (sertakan Windows.h)
Pustaka	User32.lib
DLL	User32.dll
Set API	ext-ms-win-ntuser-dialogbox-l1-1-1 (diperkenalkan dalam Windows 8.1)