Метод IKnownFolderManager::GetFolderByName (shobjidl_core.h)
Возвращает объект , представляющий известную папку, определяемую по каноническому имени. Объект позволяет запрашивать определенные свойства папки, получать текущий путь к папке, перенаправлять папку в другое расположение и получать путь к папке в виде ITEMIDLIST.
Синтаксис
HRESULT GetFolderByName(
[in] LPCWSTR pszCanonicalName,
[out] IKnownFolder **ppkf
);
Параметры
[in] pszCanonicalName
Тип: LPCWSTR
Указатель на нелокализованное каноническое имя известной папки, хранящееся в виде строки Юникода, завершаемой null. Если эта папка является общей или папкой для отдельных пользователей , это значение также используется в качестве имени значения параметров реестра "Папки оболочки пользователя". Это значение извлекается через элемент pszNameструктуры KNOWNFOLDER_DEFINITION папки.
[out] ppkf
Тип: IKnownFolder**
При возврате этого метода содержит адрес указателя на объект IKnownFolder , представляющий известную папку.
Возвращаемое значение
Тип: HRESULT
Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .
Комментарии
Когда следует использовать
Используйте этот метод, если вы точно знаете, какую известную папку вы ищете, и хотите получить к ней прямой доступ.Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows Vista [только классические приложения] |
| Минимальная версия сервера | Windows Server 2008 [только классические приложения] |
| Целевая платформа | Windows |
| Header | shobjidl_core.h (включая Shobjidl.h) |