Метод IKnownFolderManager::Redirect (shobjidl_core.h)

Статья
08/26/2023

Перенаправляет запросы папок для общих папок и папок для отдельных пользователей.

Синтаксис

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

Дескриптор родительского окна, используемого для отображения диалоговых окон хода выполнения обработчика копирования при передаче KF_REDIRECT_WITH_UI в параметре flags . Если диалоговое окно хода выполнения не требуется, это значение может иметь значение NULL.

[in] flags

Тип: KF_REDIRECT_FLAGS

Параметры перенаправления KF_REDIRECT_FLAGS.

[in, optional] pszTargetPath

Тип: LPCWSTR

Указатель на новый путь к папке. Это строка Юникода, заканчивающаяся null. Это значение может иметь значение NULL.

[in] cFolders

Тип: UINT

Число значений KNOWNFOLDERID в массиве при pExclusion.

[in] pExclusion

Тип: KNOWNFOLDERID const*

Указатель на массив значений KNOWNFOLDERID , ссылающихся на вложенные папки радиочастотной идентификации , которые должны быть исключены из перенаправления. Если вложенные папки не исключены, это значение может иметь значение NULL.

[out] ppszError

Тип: LPWSTR*

При возврате этим методом содержит адрес указателя на строку Юникода, завершающуюся null, которая содержит сообщение об ошибке, если оно было создано. Это значение может иметь значение NULL.

Возвращаемое значение

Тип: HRESULT

Возвращает S_OK в случае успешного выполнения или значение ошибки в противном случае, включая следующее:

Код возврата	Описание
E_INVALIDARG	Помимо прочего, это значение может указывать на то, что параметр радиочастотной идентификации ссылается на KNOWNFOLDERID , который отсутствует в системе. Не все значения KNOWNFOLDERID присутствуют во всех системах. Используйте IKnownFolderManager::GetFolderIds , чтобы получить набор значений KNOWNFOLDERID для текущей системы.

Код возврата

Описание

E_INVALIDARG

Помимо прочего, это значение может указывать на то, что параметр радиочастотной идентификации ссылается на KNOWNFOLDERID , который отсутствует в системе. Не все значения KNOWNFOLDERID присутствуют во всех системах. Используйте IKnownFolderManager::GetFolderIds , чтобы получить набор значений KNOWNFOLDERID для текущей системы.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	shobjidl_core.h (включая Shobjidl.h)

См. также раздел

IKnownFolderManager

Пример: известные папки