PSGetPropertyDescription 函数 (propsys.h)

获取由 PROPERTYKEY 结构指定的属性的属性的属性说明接口的实例。

语法

PSSTDAPI PSGetPropertyDescription(
  [in]  REFPROPERTYKEY propkey,
  [in]  REFIID         riid,
  [out] void           **ppv
);

参数

[in] propkey

类型: REFPROPERTYKEY

PROPERTYKEY 的引用。

[in] riid

类型: REFIID

对所请求接口的接口 ID 的引用。

[out] ppv

类型: void**

当此函数返回时,包含 riid 中请求的接口指针。 这通常是 IPropertyDescriptionIPropertyDescriptionAliasInfoIPropertyDescriptionSearchInfo

返回值

类型: PSSTDAPI

返回以下值之一。

返回代码 说明
S_OK
已获取接口。
E_INVALIDARG
ppv 参数为 NULL
TYPE_E_ELEMENTNOTFOUND
架构子系统缓存中不存在 PROPERTYKEY

注解

建议使用 objbase.h 中定义的 IID_PPV_ARGS 宏来打包 riidppv 参数。 此宏基于 ppv 中值指向的接口提供正确的 IID,这消除了编码错误的可能性。

示例

以下示例将作为较大程序的一部分包含,演示如何使用 PSGetPropertyDescription 获取 ratings 属性的属性说明。

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescription(PKEY_Ratings, IID_PPV_ARGS(&pPropDesc));

if (SUCCEEDED(hr))
{
    // pPropDesc is now valid.
 
    pPropDesc->Release();
}

要求

要求
最低受支持的客户端 Windows XP SP2、Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 SP1 [仅限桌面应用]
目标平台 Windows
标头 propsys.h
Library Propsys.lib
DLL Propsys.dll (版本 6.0 或更高版本)
可再发行组件 Windows 桌面搜索 (WDS) 3.0

另请参阅

PSGetPropertyDescriptionByName

PSGetPropertySystem