PSGetPropertyDescriptionByName function (propsys.h)

Gets an instance of a property description interface for a specified property name.

Syntax

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

Parameters

[in] pszCanonicalName

Type: LPCWSTR

A pointer to a null-terminated, Unicode string that identifies the property.

[in] riid

Type: REFIID

Reference to the interface ID of the requested property.

[out] ppv

Type: void**

When this function returns, contains the interface pointer requested in riid. This is typically IPropertyDescription, IPropertyDescriptionAliasInfo, or IPropertyDescriptionSearchInfo.

Return value

Type: PSSTDAPI

Returns one of the following values.

Remarks

It is recommended that you use the IID_PPV_ARGS macro, defined in objbase.h, to package the riid and ppv parameters. This macro provides the correct IID based on the interface pointed to by the value in ppv, eliminating the possibility of a coding error.

We recommend that pszCanonicalName point to the canonical name of a property, for example, L"System.Keywords". The canonical name is case sensitive.

In addition to the new canonical names, callers can pass a legacy name for a property. The following table contains the complete list of supported legacy names and the canonical names they correspond to.

Examples

The following example, to be included as part of a larger program, demonstrates how to use PSGetPropertyDescriptionByName to retrieve the description for the ratings property.

IPropertyDescription *pPropDesc;

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

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

Requirements

See also

IPropertySystem

PSGetPropertyDescription