Metode IPropertyStore::SetValue (propsys.h)

Metode ini menetapkan nilai properti atau mengganti atau menghapus nilai yang ada.

Sintaks

HRESULT SetValue(
  REFPROPERTYKEY key,
  REFPROPVARIANT propvar
);

Parameter

key

TBD

propvar

TBD

Nilai kembali

Metode ini IPropertyStore::SetValue dapat mengembalikan salah satu hal berikut:

Menampilkan kode	Deskripsi
S_OK	Perubahan properti berhasil.
INPLACE_S_TRUNCATED	Nilai diatur tetapi terpotong.
STG_E_ACCESSDENIED	Ini adalah kode kesalahan. Penyimpanan properti bersifat baca-saja sehingga metode tidak dapat mengatur nilai.

Keterangan

IPropertyStore::SetValue hanya memengaruhi instans penyimpanan properti saat ini. Handler properti mengimplementasikan IPropertyStore::SetValue dengan mengakumulasi perubahan properti dalam struktur data dalam memori. Perubahan properti ditulis ke aliran hanya ketika IPropertyStore::Commit dipanggil.

Jika IPropertyStore::Commit dipanggil pada penyimpanan properti baca-saja, handler properti menentukan ini dan mengembalikan STG_E_ACCESSDENIED.

Jika nilai ditambahkan atau dihapus sebagai hasil dari SetValue, enumerasi berikutnya oleh IPropertyStore::GetCount dan IPropertyStore::GetAt mencerminkan perubahan tersebut dan panggilan berikutnya untuk IPropertyStore::SetValue mencerminkan nilai yang diubah.

Menambahkan Properti Baru

Jika nilai properti yang diacu oleh kunci tidak ada di penyimpanan, IPropertyStore::SetValue menambahkan nilai ke penyimpanan.

Mengganti Nilai Properti yang Ada

Jika nilai properti yang diacu oleh kunci sudah ada di penyimpanan, nilai yang disimpan akan diganti.

Menghapus Properti yang Ada

Untuk menghapus nilai dari penyimpanan properti, atur anggota vt struktur yang diacu oleh pv ke VT_EMPTY. Jika nilai tersebut tidak ada, jangan lakukan apa-apa dan metode mengembalikan S_OK.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Tersedia dengan Windows Vista dan versi sistem operasi Windows yang lebih baru.
Target Platform	Universal
Header	propsys.h
Pustaka	Propsys.idl
IRQL	Semua tingkatan

Lihat juga

IPropertyStore

IPropertyStore::Commit

IPropertyStore::GetAt

IPropertyStore::GetCount