SHGetViewStatePropertyBag 函式 (shlwapi.h)

發行項
03/05/2024

[SHGetViewStatePropertyBag 可用於需求一節中指定的操作系統。它可能會在後續版本中改變或無法使用。]

擷取屬性包，其中可以儲存及擷取資料夾的檢視狀態資訊。下次使用者瀏覽資料夾時，會保留用戶的設定。

語法

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

參數

[in, optional] pidl

類型： PCIDLIST_ABSOLUTE

您要要求屬性之資料夾的 PIDL。如果傳遞SHGVSPB_ALLFOLDERS旗標，此參數必須是 NULL 。

[in, optional] pszBagName

類型： PCWSTR

字串的指標，其中包含要求的屬性包名稱。

dwFlags

類型： DWORD

值，指定下列旗標的組合。

需要下列一組旗標的一個值。

SHGVSPB_PERUSER

傳回指定 pidl 的每個用戶屬性。

SHGVSPB_ALLUSERS

傳回指定 pidl 的 [所有使用者] 屬性。

需要下列一組旗標的一個值。

SHGVSPB_PERFOLDER

傳回 pidl 參數所指定之資料夾的屬性包。

SHGVSPB_ALLFOLDERS

傳回套用至所有資料夾的屬性包。

SHGVSPB_INHERIT

傳回屬性包，用來提供沒有其屬性包之子資料夾的預設值。

下列旗標是選擇性的。

SHGVSPB_ROAM

允許屬性包漫遊。請參閱漫遊使用者配置檔。此旗標無法與SHGVSPB_ALLFOLDERS結合。

SHGVSPB_NOAUTODEFAULTS

當找不到指定資料夾的屬性包時，隱藏搜尋適當的預設值。根據預設，如果未指定SHGVSPB_INHERIT，而且找不到指定資料夾的屬性包，則系統會在其他位置搜尋可能可以提供預設值的相同名稱屬性包。例如，系統會在資料夾的上階中搜尋，以查看其中任何一個是否提供SHGVSPB_INHERIT屬性包。系統搜尋的其他位置位於用戶預設值和全域預設值中。

下列一組旗標是由結合上述某些旗標的值所組成，並用於簡潔且方便。

SHGVSPB_FOLDER

結合SHGVSPB_PERUSER和SHGVSPB_PERFOLDER。

SHGVSPB_FOLDERNODEFAULTS

結合SHGVSPB_PERUSER、SHGVSPB_PERFOLDER和SHGVSPB_NOAUTODEFAULTS。

SHGVSPB_USERDEFAULTS

結合SHGVSPB_PERUSER和SHGVSPB_ALLFOLDERS。

SHGVSPB_GLOBALDEFAULTS

結合SHGVSPB_ALLUSERS和SHGVSPB_ALLFOLDERS。

Windows Server 2008、Windows Vista、Windows Server 2003 和 Windows XP： 此旗標名為 SHGVSPB_GLOBALDEAFAULTS。

[in] riid

類型： REFIID

要透過 ppv 擷取之介面 IID 的參考。

[out] ppv

類型： void**

當這個方法成功傳回時，包含 riid中要求的介面指標。

傳回值

類型： HRESULT

如果此函式成功，則會傳回 S_OK。否則，它會傳回 HRESULT 錯誤碼。

備註

重要資訊不應儲存在檢視狀態屬性包中，因為系統只會保留有限的檢視狀態數目。如果未長時間瀏覽資料夾，則最終會刪除其檢視狀態。

建議您使用在 Objbase.h 中定義的 IID_PPV_ARGS 宏來封裝 riid 和 ppv 參數。此宏會根據 ppv 中值所指向的介面提供正確的 IID，這可消除 riid 中可能導致非預期結果的編碼錯誤的可能性。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	shlwapi.h
程式庫	Shlwapi.lib
Dll	Shlwapi.dll (5.0 版或更新版本)

共用方式為