Metode IPropertyStorage::WritePropertyNames (propidlbase.h)

Artikel
08/25/2023

Metode WritePropertyNames menetapkan nama string IPropertyStorage ke array ID properti tertentu dalam kumpulan properti saat ini.

Sintaks

HRESULT WritePropertyNames(
  [in] ULONG             cpropid,
  [in] const PROPID []   rgpropid,
  [in] const LPOLESTR [] rglpwstrName
);

Parameter

[in] cpropid

Ukuran pada input array rgpropid. Bisa nol. Namun, menjadikannya nol menyebabkan metode ini menjadi tidak beroperasi.

[in] rgpropid

Array ID properti yang namanya akan diatur.

[in] rglpwstrName

Array nama baru yang akan ditetapkan ke ID properti yang sesuai dalam array rgpropid . Nama-nama ini tidak boleh melebihi 255 karakter (tidak termasuk terminator NULL ).

Nilai kembali

Metode ini mendukung nilai pengembalian standar E_UNEXPECTED, selain yang berikut ini:

Keterangan

Untuk informasi selengkapnya tentang kumpulan properti dan manajemen memori, lihat Mengelola Set Properti.

IPropertyStorage::WritePropertyNames menetapkan nama string ke ID properti yang diteruskan ke metode dalam array rgpropid . Ini mengaitkan setiap nama string dalam array rglpwstrName dengan ID properti masing-masing dalam rgpropid. Secara eksplisit valid untuk menentukan nama untuk ID properti yang saat ini tidak ada di objek penyimpanan properti.

Ini juga valid untuk mengubah pemetaan untuk nama string yang ada (ditentukan oleh kecocokan yang tidak peka huruf besar/kecil). Artinya, Anda dapat menggunakan metode WritePropertyNames untuk memetakan nama yang ada ke ID properti baru, atau untuk memetakan nama baru ke ID properti yang sudah memiliki nama dalam kamus. Dalam kedua kasus, pemetaan asli dihapus. Nama properti harus unik (seperti halnya ID properti) dalam kumpulan properti.

Penyimpanan nama properti string mempertahankan kasus. Kecuali PROPSETFLAG_CASE_SENSITIVE diteruskan ke IPropertySetStorage::Create, nama set properti tidak peka huruf besar/kecil secara default. Dengan kumpulan properti yang tidak peka huruf besar/kecil, string nama yang diteruskan oleh pemanggil ditafsirkan sesuai dengan lokal kumpulan properti, seperti yang ditentukan oleh properti PID_LOCALE . Jika kumpulan properti tidak memiliki properti lokal, pengguna saat ini diasumsikan secara default. Panjang nama properti string dibatasi hingga 128 karakter. Nama properti yang dimulai dengan karakter Unicode biner 0x0001 melalui 0x001F disediakan untuk digunakan di masa mendatang.

Jika nilai elemen dalam parameter array rgpropid diatur ke 0xffffffff (PID_ILLEGAL), nama yang sesuai diabaikan oleh IPropertyStorage::WritePropertyNames. Misalnya, jika metode ini dipanggil dengan parameter cpropid 3, tetapi elemen pertama dari array, rgpropid[1], diatur ke PID_ILLEGAL, maka hanya dua nama properti yang ditulis. Elemen rgpropid[1] diabaikan.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows 2000 Server [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	propidlbase.h (termasuk Objbase.h, Propidlbase.h)
Pustaka	Uuid.lib
DLL	Ole32.dll