Метод IKnownFolder::GetFolderDefinition (shobjidl_core.h)
Извлекает структуру, содержащую определяющие элементы известной папки, которая включает категорию папки, имя, путь, описание, подсказку, значок и другие свойства.
Синтаксис
HRESULT GetFolderDefinition(
[out] KNOWNFOLDER_DEFINITION *pKFD
);
Параметры
[out] pKFD
Тип: KNOWNFOLDER_DEFINITION*
При возврате этого метода содержит указатель на структуру KNOWNFOLDER_DEFINITION . Если вызывающее приложение больше не требуется, оно отвечает за вызов FreeKnownFolderDefinitionFields для освобождения этого ресурса.
Возвращаемое значение
Тип: HRESULT
Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .
Комментарии
Когда стороннее приложение создает собственную известную папку, они определяют ее с KNOWNFOLDER_DEFINITION структурой, а затем регистрируют ее в системе. С помощью этого метода можно получить любые зарегистрированные известные сведения об определении папки ( предоставленные системой или созданные приложением).
Чтобы вызвать этот метод, вызывающий объект должен иметь по крайней мере права пользователя.
Требования
| Минимальная версия клиента | Windows Vista [только классические приложения] |
| Минимальная версия сервера | Windows Server 2008 [только классические приложения] |
| Целевая платформа | Windows |
| Header | shobjidl_core.h (включая Shobjidl.h) |