Метод IPropertyDescription::GetRelativeDescription (propsys.h)

  • Статья

Сравнивает два значения свойств способом, указанным в описании свойства. Возвращает две отображаемые строки, описывающие сравнение двух свойств.

Синтаксис

HRESULT GetRelativeDescription(
  [in]  REFPROPVARIANT propvar1,
  [in]  REFPROPVARIANT propvar2,
  [out] LPWSTR         *ppszDesc1,
  [out] LPWSTR         *ppszDesc2
);

Параметры

[in] propvar1

Тип: REFPROPVARIANT

Ссылка на структуру PROPVARIANT , содержащую тип и значение первого свойства.

[in] propvar2

Тип: REFPROPVARIANT

Ссылка на структуру PROPVARIANT , содержащую тип и значение второго свойства.

[out] ppszDesc1

Тип: LPWSTR*

При возврате этим методом содержит адрес указателя на строку описания, которая сравнивает первое свойство со вторым. Строка заканчивается null.

[out] ppszDesc2

Тип: LPWSTR*

При возврате этим методом содержит адрес указателя на строку описания, которая сравнивает второе свойство с первым. Строка заканчивается null.

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

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

На этот метод влияет атрибут relativeDescriptionType элемента displayInfo в PROPDESC-файле свойства.

Вызывающее приложение отвечает за освобождение ppszDesc1 и ppszDesc2 через CoTaskMemFree, когда они больше не нужны.

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2008 [только классические приложения]
Целевая платформа Windows
Header propsys.h

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

IPropertyDescription

Схема описания свойства