Fungsi SetPropA (winuser.h)

Artikel
08/28/2023

Menambahkan entri baru atau mengubah entri yang ada dalam daftar properti dari jendela yang ditentukan. Fungsi menambahkan entri baru ke daftar jika string karakter yang ditentukan belum ada dalam daftar. Entri baru berisi string dan handel. Jika tidak, fungsi mengganti handel string saat ini dengan handel yang ditentukan.

Sintaks

BOOL SetPropA(
  [in]           HWND   hWnd,
  [in]           LPCSTR lpString,
  [in, optional] HANDLE hData
);

Parameter

[in] hWnd

Jenis: HWND

Handel ke jendela yang daftar propertinya menerima entri baru.

[in] lpString

Jenis: LPCTSTR

String yang dihentikan null atau atom yang mengidentifikasi string. Jika parameter ini adalah atom, parameter harus merupakan atom global yang dibuat oleh panggilan sebelumnya ke fungsi GlobalAddAtom . Atom harus ditempatkan dalam kata lpString urutan rendah; kata urutan tinggi harus nol.

[in, optional] hData

Jenis: HANDEL

Handel ke data yang akan disalin ke daftar properti. Handel data dapat mengidentifikasi nilai apa pun yang berguna untuk aplikasi.

Nilai kembali

Jenis: BOOL

Jika handel data dan string ditambahkan ke daftar properti, nilai yang dikembalikan bukan nol.

Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.

Keterangan

Sebelum jendela dihancurkan (yaitu, sebelum kembali dari memproses pesan WM_NCDESTROY ), aplikasi harus menghapus semua entri yang telah ditambahkan ke daftar properti. Aplikasi harus menggunakan fungsi RemoveProp untuk menghapus entri.

SetProp tunduk pada pembatasan Isolasi Hak Istimewa Antarmuka Pengguna (UIPI). Proses hanya dapat memanggil fungsi ini pada jendela milik proses tingkat integritas yang lebih rendah atau sama dengan. Ketika UIPI memblokir perubahan properti, GetLastError akan mengembalikan 5.

Contoh

Misalnya, lihat Menambahkan Properti Jendela.

Catatan

Header winuser.h mendefinisikan SetProp 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 (termasuk Windows.h)
Pustaka	User32.lib
DLL	User32.dll
Set API	ext-ms-win-ntuser-window-l1-1-4 (diperkenalkan dalam Windows 10, versi 10.0.14393)