Fungsi PropertySheetW (prsht.h)

  • Artikel

Membuat lembar properti dan menambahkan halaman yang ditentukan dalam struktur header lembar properti yang ditentukan.

Sintaks

INT_PTR PropertySheetW(
  LPCPROPSHEETHEADERW unnamedParam1
);

Parameter

unnamedParam1

Jenis: LPCPROPSHEETHEADER

Penunjuk ke struktur PROPSHEETHEADER yang menentukan bingkai dan halaman lembar properti.

Mengembalikan nilai

Jenis: INT_PTR

Untuk lembar properti modal, nilai yang dikembalikan adalah sebagai berikut:

>=1 Perubahan disimpan oleh pengguna.
0 Tidak ada perubahan yang disimpan oleh pengguna.
-1 Terjadi kesalahan.
 

Untuk lembar properti tanpa mode, nilai yang dikembalikan adalah handel jendela lembar properti.

Nilai pengembalian berikut memiliki arti khusus.

Menampilkan kode Deskripsi
ID_PSREBOOTSYSTEM
 Halaman mengirim pesan PSM_REBOOTSYSTEM ke lembar properti. Komputer harus dimulai ulang agar perubahan pengguna berlaku.
ID_PSRESTARTWINDOWS
 Halaman mengirim pesan PSM_RESTARTWINDOWS ke lembar properti. Windows harus dimulai ulang agar perubahan pengguna berlaku.

Keterangan

Untuk mengambil informasi kesalahan yang diperluas, panggil GetLastError.

Jika Anda mencoba menambahkan lebih dari 99 halaman ke lembar properti, fungsi ini akan gagal, tetapi tanpa indikasi penyebab kesalahan: PropertySheet mengembalikan nilai -1, tetapi GetLastError mengembalikan 0.

Catatan Keterangan berikut ini hanya merujuk ke panduan yang tidak menggunakan gaya panduan Aero (PSH_AEROWIZARD) atau lembar properti non-wizard.
 
Secara default, fungsi PropertySheet membuat kotak dialog modal. Jika anggota dwFlags dari struktur PROPSHEETHEADER menentukan bendera PSH_MODELESS, PropertySheet membuat kotak dialog tanpa mode dan segera kembali setelah dibuat. Dalam hal ini, nilai pengembalian PropertySheet adalah handel jendela ke kotak dialog tanpa mode.

Untuk lembar properti tanpa mode, perulangan pesan Anda harus menggunakan PSM_ISDIALOGMESSAGE untuk meneruskan pesan ke kotak dialog lembar properti. Perulangan pesan Anda harus menggunakan PSM_GETCURRENTPAGEHWND untuk menentukan kapan harus menghancurkan kotak dialog. Saat pengguna mengklik tombol OK atau Batal , PSM_GETCURRENTPAGEHWND mengembalikan NULL. Anda kemudian dapat menggunakan fungsi DestroyWindow untuk menghancurkan kotak dialog.

Versi 5.80. Nilai pengembalian PropertySheet membawa informasi yang berbeda untuk lembar properti modal dan tanpa mode. Dalam beberapa kasus, lembar properti tanpa mode mungkin memerlukan informasi yang akan mereka terima dari PropertySheet jika telah dimodifikasi. Secara khusus, mereka mungkin perlu mengetahui apakah ID_PSREBOOTSYSTEM atau ID_PSRESTARTWINDOWS akan dikembalikan. Lembar properti tanpa mode dapat mengambil nilai yang akan diterima lembar properti modal dari PropertySheet dengan menunggu hingga PSM_GETCURRENTPAGEHWND mengembalikan NULL lalu mengirim pesan PSM_GETRESULT .

Catatan

Header prsht.h mendefinisikan PropertySheet 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

   
Klien minimum yang didukung Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung Windows Server 2003 [hanya aplikasi desktop]
Target Platform Windows
Header prsht.h
Pustaka Comctl32.lib
DLL Comctl32.dll
Set API ext-ms-win-shell-comctl32-window-l1-1-0 (diperkenalkan dalam Windows 10, versi 10.0.14393)