IKnownFolderManager：：GetFolderByName 方法 (shobjidl_core.h)

  • 项目

获取一个 对象，该对象表示由其规范名称标识的已知文件夹。 对象允许查询某些文件夹属性、获取文件夹的当前路径、将文件夹重定向到另一个位置，以及获取 作为 ITEMIDLIST 的文件夹路径。

语法

HRESULT GetFolderByName(
  [in]  LPCWSTR      pszCanonicalName,
  [out] IKnownFolder **ppkf
);

参数

[in] pszCanonicalName

类型： LPCWSTR

指向已知文件夹的非本地化规范名称的指针，存储为以 null 结尾的 Unicode 字符串。 如果此文件夹是 通用 文件夹或 每用户 文件夹，则此值也用作“User Shell 文件夹”注册表设置的值名称。 此值通过文件夹的 KNOWNFOLDER_DEFINITION 结构的 pszName 成员检索。

[out] ppkf

类型： IKnownFolder**

此方法返回时，包含指向表示已知文件夹的 IKnownFolder 对象的指针的地址。

返回值

类型： HRESULT

如果该方法成功，则返回 S_OK。 否则，将返回 HRESULT 错误代码。

注解

何时使用

当您确切知道要查找的已知文件夹并希望直接访问它时，请使用此方法。

要求

要求 值
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 shobjidl_core.h (包括 Shobjidl.h)

另请参阅

IKnownFolderManager

已知文件夹示例