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，否则返回错误值，包括以下内容：

返回代码 说明
E_INVALIDARG
 除其他事项外，此值可以指示 该参数 引用系统上不存在的 KNOWNFOLDERID 。 并非所有 KNOWNFOLDERID 值都存在于所有系统上。 使用 IKnownFolderManager：：GetFolderIds 检索当前系统的 KNOWNFOLDERID 值集。

要求

要求 值
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 shobjidl_core.h (包括 Shobjidl.h)

另请参阅

IKnownFolderManager

已知文件夹示例