IKnownFolderManager：：Redirect 方法 (shobjidl_core.h)

  • 發行項

重新導向一般和每個使用者資料夾的資料夾要求。

語法

HRESULT Redirect(
  [in]           REFKNOWNFOLDERID    rfid,
  [in, optional] HWND                hwnd,
  [in]           KF_REDIRECT_FLAGS   flags,
  [in, optional] LPCWSTR             pszTargetPath,
  [in]           UINT                cFolders,
  [in]           const KNOWNFOLDERID *pExclusion,
  [out]          LPWSTR              *ppszError
);

參數

[in] rfid

類型： REFKNOWNFOLDERID

要重新導向之資料夾的 KNOWNFOLDERID 參考。

[in, optional] hwnd

類型： HWND

在 flags 參數中傳遞KF_REDIRECT_WITH_UI時，用來顯示複製引擎進度 UI 對話框的父視窗句柄。 如果需要任何進度對話框，此值可以是 NULL。

[in] flags

類型： KF_REDIRECT_FLAGS

重新 導向的KF_REDIRECT_FLAGS 選項。

[in, optional] pszTargetPath

類型： LPCWSTR

資料夾新路徑的指標。 這是以 Null 結尾的 Unicode 字串。 此值可以是 NULL。

[in] cFolders

類型： UINT

pExclusion 陣列中的 KNOWNFOLDERID 值數目。

[in] pExclusion

類型： KNOWNFOLDERID const*

KNOWNFOLDERID 值的數位指標，這些值參照應該從重新導向中排除的子資料夾。 如果沒有排除子資料夾，這個值可以是 NULL。

[out] ppszError

類型： LPWSTR*

當這個方法傳回時，會包含 Null 終止 Unicode 字串的指標位址，如果產生錯誤訊息，則會包含錯誤訊息。 此值可以是 NULL。

傳回值

類型： HRESULT

如果成功，則傳回S_OK，否則傳回錯誤值，包括下列專案：

傳回碼 Description
E_INVALIDARG
 此外，這個值也可以指出 ，此標識符會 參考系統上不存在的 KNOWNFOLDERID 。 並非所有 KNOWNFOLDERID 值都存在於所有系統上。 使用 IKnownFolderManager：：GetFolderIds 來擷取目前系統的 KNOWNFOLDERID 值集。

規格需求

需求 值
最低支援的用戶端 Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2008 [僅限傳統型應用程式]
目標平台 Windows
標頭 shobjidl_core.h (包括 Shobjidl.h)

另請參閱

IKnownFolderManager

已知資料夾範例