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

Метод IPropertySystem::GetPropertyDescriptionByName (propsys.h)

  • Статья

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

Синтаксис

HRESULT GetPropertyDescriptionByName(
  [in]  LPCWSTR pszCanonicalName,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Параметры

[in] pszCanonicalName

Тип: LPCWSTR

Указатель на строку, определяющую свойство .

[in] riid

Тип: REFIID

Ссылка на требуемый IID.

[out] ppv

Тип: void**

Адрес указателя интерфейса IPropertyDescription .

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

Тип: PSSTDAPI

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

Код возврата Описание
S_OK
 Указывает, что интерфейс получен.
E_INVALIDARG
 Указывает, что pszCanonicalName имеет значение NULL.
TYPE_E_ELEMENTNOTFOUND
 Указывает, что каноническое имя не существует в кэше подсистемы схемы.

Комментарии

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

Требования

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

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

IPropertySystem