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

Статья
03/01/2024

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

Синтаксис

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

Параметры

[in] propkey

Тип: REFPROPERTYKEY

Ссылка на PROPERTYKEY.

[in] riid

Тип: REFIID

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

[out] ppv

Тип: void**

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

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

Тип: PSSTDAPI

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

Код возврата	Описание
S_OK	Интерфейс получен.
E_INVALIDARG	Параметр ppv имеет значение NULL.
TYPE_E_ELEMENTNOTFOUND	PROPERTYKEY не существует в кэше подсистемы схемы.

Мы рекомендуем использовать макрос IID_PPV_ARGS , определенный в Objbase.h, для упаковки параметров riid и ppv . Этот макрос предоставляет правильный IID на основе интерфейса, на который указывает значение в ppv, что исключает возможность ошибки кода.

Примеры

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

IPropertyDescription *pPropDesc;

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

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

Требования

Требование	Значение
Минимальная версия клиента	Windows XP с пакетом обновления 2 (SP2), Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 с пакетом обновления 1 (SP1) [только классические приложения]
Целевая платформа	Windows
Header	propsys.h
Библиотека	Propsys.lib
DLL	Propsys.dll (версия 6.0 или более поздняя)
Распространяемые компоненты	Windows Desktop Search (WDS) 3.0

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

PSGetPropertyDescriptionByName

PSGetPropertySystem

Поделиться через