IPropertyDescription::GetRelativeDescription-Methode (propsys.h)

  • Artikel

Vergleicht zwei Eigenschaftswerte in der in der Eigenschaftenbeschreibung angegebenen Weise. Gibt zwei Anzeigezeichenfolgen zurück, die den Vergleich der beiden Eigenschaften beschreiben.

Syntax

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

Parameter

[in] propvar1

Typ: REFPROPVARIANT

Ein Verweis auf eine PROPVARIANT-Struktur , die den Typ und den Wert der ersten Eigenschaft enthält.

[in] propvar2

Typ: REFPROPVARIANT

Ein Verweis auf eine PROPVARIANT-Struktur , die den Typ und den Wert der zweiten Eigenschaft enthält.

[out] ppszDesc1

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält die Adresse eines Zeigers auf die Beschreibungszeichenfolge, die die erste Eigenschaft mit der zweiten Eigenschaft vergleicht. Die Zeichenfolge ist null-beendet.

[out] ppszDesc2

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält die Adresse eines Zeigers auf die Beschreibungszeichenfolge, die die zweite Eigenschaft mit der ersten Eigenschaft vergleicht. Die Zeichenfolge ist null-beendet.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Diese Methode wird durch das relativeDescriptionType-Attribut des displayInfo-Elements in der PROPDESC-Datei der Eigenschaft beeinflusst.

Es liegt in der Verantwortung der aufrufenden Anwendung , ppszDesc1 und ppszDesc2 über CoTaskMemFree freizugeben, wenn sie nicht mehr benötigt werden.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile propsys.h

Weitere Informationen

IPropertyDescription

Eigenschaftenbeschreibungsschema