Функция PSGetPropertyDescriptionByName (propsys.h)

Возвращает экземпляр интерфейса описания свойства для указанного имени свойства.

Синтаксис

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

Параметры

[in] pszCanonicalName

Тип: LPCWSTR

Указатель на строку Юникода, завершающуюся null, которая идентифицирует свойство .

[in] riid

Тип: REFIID

Ссылка на идентификатор интерфейса запрошенного свойства.

[out] ppv

Тип: void**

При возврате этой функции содержит указатель интерфейса, запрошенный в riid. Обычно это IPropertyDescription, IPropertyDescriptionAliasInfo или IPropertyDescriptionSearchInfo.

Возвращаемое значение

Тип: PSSTDAPI

Возвращает одно из следующих значений.

Комментарии

Рекомендуется использовать макрос IID_PPV_ARGS, определенный в objbase.h, для упаковки параметров riid и ppv . Этот макрос предоставляет правильный КОД на основе интерфейса, на который указывает значение в ppv, устраняя возможность ошибки кода.

Рекомендуется, чтобы pszCanonicalName указывал на каноническое имя свойства, например L"System.Keywords". Каноническое имя учитывает регистр.

В дополнение к новым каноническим именам вызывающие объекты могут передавать устаревшее имя для свойства. В следующей таблице приведен полный список поддерживаемых устаревших имен и канонических имен, которым они соответствуют.

Примеры

В следующем примере, который будет включен в состав более крупной программы, показано, как использовать PSGetPropertyDescriptionByName для получения описания свойства ratings.

IPropertyDescription *pPropDesc;

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

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

Требования

См. также раздел

IPropertySystem

PSGetPropertyDescription