Метод IKnownFolder::SetPath (shobjidl_core.h)

Назначает новый путь к известной папке.

Синтаксис

HRESULT SetPath(
  [in] DWORD   dwFlags,
  [in] LPCWSTR pszPath
);

Параметры

[in] dwFlags

Тип: DWORD

Либо ноль, либо следующее значение:

KF_FLAG_DONT_UNEXPAND

Задайте полный путь без строк среды. Если этот флаг не задан, части пути в pszPath могут быть представлены строками среды, такими как %USERPROFILE%.

[in] pszPath

Тип: LPCWSTR

Указатель на новый путь к папке. Это строка Юникода длиной MAX_PATH, заканчивающаяся null. Длина этого пути не может быть нулевой. Если это значение равно NULL, IKnownFolder::SetPath задает путь к значению по умолчанию.

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

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Этот метод не может вызываться для папок типа KF_CATEGORY_FIXED или KF_CATEGORY_VIRTUAL.

Чтобы вызвать этот метод в папке типа KF_CATEGORY_COMMON, вызывающее приложение должно выполняться с повышенными привилегиями.

Этот метод эквивалентен SHSetKnownFolderPath.

Требования

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

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

IKnownFolder

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

SHSetKnownFolderPath