PSGetPropertyDescriptionByName 函数 (propsys.h)

获取指定属性名称的属性说明接口的实例。

语法

PSSTDAPI PSGetPropertyDescriptionByName(
  [in]  LPCWSTR pszCanonicalName,
  [in]  REFIID  riid,
  [out] void    **ppv
);

parameters

[in] pszCanonicalName

类型： LPCWSTR

指向以 null 结尾的 Unicode 字符串的指针，该字符串标识属性。

[in] riid

类型： REFIID

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

[out] ppv

类型： void**

当此函数返回时，包含 riid 中请求的接口指针。 这通常是 IPropertyDescription、 IPropertyDescriptionAliasInfo 或 IPropertyDescriptionSearchInfo。

返回值

类型： PSSTDAPI

返回以下值之一。

注解

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

建议 pszCanonicalName 指向属性的规范名称，例如 L"System.Keywords"。 规范名称区分大小写。

除了新的规范名称，调用方还可以传递属性的旧名称。 下表包含受支持的旧名称及其对应的规范名称的完整列表。

示例

以下示例将作为较大程序的一部分包含，演示如何使用 PSGetPropertyDescriptionByName 检索分级属性的说明。

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescriptionByName(L"System.Rating", IID_PPV_ARGS(&pPropDesc))

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

要求

请参阅

IPropertySystem

PSGetPropertyDescription