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
标头 shobjidl_core.h (包括 Shobjidl.h)

另请参阅

IKnownFolder

已知文件夹示例