Fungsi SHGetViewStatePropertyBag (shlwapi.h)

Artikel
03/15/2023

[SHGetViewStatePropertyBag tersedia untuk digunakan dalam sistem operasi yang ditentukan di bagian Persyaratan. Ini mungkin diubah atau tidak tersedia dalam versi berikutnya.]

Mengambil tas properti tempat informasi status tampilan untuk folder dapat disimpan dan kemudian diambil. Pengaturan pengguna disimpan untuk kali berikutnya pengguna mengunjungi folder.

Sintaks

LWSTDAPI SHGetViewStatePropertyBag(
  [in, optional] PCIDLIST_ABSOLUTE pidl,
  [in, optional] PCWSTR            pszBagName,
                 DWORD             dwFlags,
  [in]           REFIID            riid,
  [out]          void              **ppv
);

Parameter

[in, optional] pidl

Jenis: PCIDLIST_ABSOLUTE

PIDL folder yang Anda minta propertinya. Parameter ini harus NULL jika bendera SHGVSPB_ALLFOLDERS diteruskan.

[in, optional] pszBagName

Jenis: PCWSTR

Penunjuk ke string yang berisi nama tas properti yang diminta.

dwFlags

Jenis: DWORD

Nilai yang menentukan kombinasi bendera berikut.

Satu nilai dari kumpulan bendera berikut diperlukan.

SHGVSPB_PERUSER

Mengembalikan properti per pengguna untuk pidl yang ditentukan.

SHGVSPB_ALLUSERS

Mengembalikan properti Semua Pengguna untuk pidl yang ditentukan.

Satu nilai dari kumpulan bendera berikut diperlukan.

SHGVSPB_PERFOLDER

Mengembalikan tas properti untuk folder yang ditentukan oleh parameter pidl .

SHGVSPB_ALLFOLDERS

Mengembalikan tas properti yang berlaku untuk semua folder.

SHGVSPB_INHERIT

Mengembalikan tas properti yang digunakan untuk menyediakan default untuk subfolder yang tidak memiliki tas properti mereka.

Bendera berikut bersifat opsional.

SHGVSPB_ROAM

Memungkinkan tas properti berkeliaran. Lihat Profil Pengguna Roaming. Bendera ini tidak dapat digabungkan dengan SHGVSPB_ALLFOLDERS.

SHGVSPB_NOAUTODEFAULTS

Menekan pencarian untuk default yang sesuai ketika tas properti tidak dapat ditemukan untuk folder yang ditentukan. Secara default, jika SHGVSPB_INHERIT tidak ditentukan dan tas properti tidak dapat ditemukan untuk folder yang ditentukan, sistem mencari tas properti bernama identik di lokasi lain yang mungkin dapat memberikan nilai default. Misalnya, sistem mencari di leluhur folder untuk melihat apakah salah satu dari mereka menyediakan tas properti SHGVSPB_INHERIT. Tempat lain pencarian sistem berada di default pengguna dan default global.

Set bendera berikut terdiri dari nilai yang menggabungkan beberapa bendera yang tercantum di atas, dan digunakan untuk kemudahan dan kemudahan.

SHGVSPB_FOLDER

Menggabungkan SHGVSPB_PERUSER dan SHGVSPB_PERFOLDER.

SHGVSPB_FOLDERNODEFAULTS

Menggabungkan SHGVSPB_PERUSER, SHGVSPB_PERFOLDER, dan SHGVSPB_NOAUTODEFAULTS.

SHGVSPB_USERDEFAULTS

Menggabungkan SHGVSPB_PERUSER dan SHGVSPB_ALLFOLDERS.

SHGVSPB_GLOBALDEFAULTS

Menggabungkan SHGVSPB_ALLUSERS dan SHGVSPB_ALLFOLDERS.

Windows Server 2008, Windows Vista, Windows Server 2003 dan Windows XP: Bendera ini diberi nama SHGVSPB_GLOBALDEAFAULTS.

[in] riid

Jenis: REFIID

Referensi ke IID antarmuka untuk diambil melalui ppv.

[out] ppv

Jenis: batal**

Ketika metode ini berhasil dikembalikan, berisi pointer antarmuka yang diminta dalam riid.

Mengembalikan nilai

Jenis: HRESULT

Jika fungsi ini berhasil, fungsi akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.

Keterangan

Informasi penting tidak boleh disimpan dalam tas properti status tampilan karena sistem hanya menyimpan jumlah status tampilan yang terbatas. Jika folder tidak dikunjungi untuk waktu yang lama, status tampilannya akhirnya dihapus.

Kami menyarankan agar Anda menggunakan makro IID_PPV_ARGS , yang ditentukan dalam Objbase.h, untuk mengemas parameter riid dan ppv . Makro ini menyediakan IID yang benar berdasarkan antarmuka yang ditunjukkan oleh nilai dalam ppv, yang menghilangkan kemungkinan kesalahan pengkodian dalam riid yang dapat menyebabkan hasil yang tidak terduga.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	shlwapi.h
Pustaka	Shlwapi.lib
DLL	Shlwapi.dll (versi 5.0 atau yang lebih baru)

Bagikan melalui