IKnownFolderManager::GetFolderByName 方法 (shobjidl_core.h)
取得物件,表示其標準名稱所識別的已知資料夾。 物件可讓您查詢特定資料夾屬性、取得資料夾的目前路徑、將資料夾重新導向至另一個位置,以及取得資料夾的路徑做為 ITEMIDLIST。
語法
HRESULT GetFolderByName(
[in] LPCWSTR pszCanonicalName,
[out] IKnownFolder **ppkf
);
參數
[in] pszCanonicalName
類型: LPCWSTR
已知資料夾的非當地語系化標準名稱指標,儲存為 Null 終止的 Unicode 字串。 如果這個資料夾是 通用 或 每個使用者 資料夾,這個值也會當做「用戶殼層資料夾」登錄設定的值名稱使用。 這個值是透過資料夾KNOWNFOLDER_DEFINITION結構的pszName 成員擷取。
[out] ppkf
類型: IKnownFolder**
當這個方法傳回時,會包含代表已知資料夾之 IKnownFolder 物件的指標位址。
傳回值
類型: HRESULT
如果此方法成功,則會傳回 S_OK。 否則,它會傳回 HRESULT 錯誤碼。
備註
使用時機
當您知道您要尋找的已知資料夾,並想要直接存取它時,請使用這個方法。規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | shobjidl_core.h (包括 Shobjidl.h) |