IPropertyDescription::GetRelativeDescription method

Compares two property values in the manner specified by the property description. Returns two display strings that describe how the two properties compare.

Syntax


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

Parameters

propvar1 [in]

Type: REFPROPVARIANT

A reference to a PROPVARIANT structure that contains the type and value of the first property.

propvar2 [in]

Type: REFPROPVARIANT

A reference to a PROPVARIANT structure that contains the type and value of the second property.

ppszDesc1 [out]

Type: LPWSTR*

When this method returns, contains the address of a pointer to the description string that compares the first property with the second property. The string is null-terminated.

ppszDesc2 [out]

Type: LPWSTR*

When this method returns, contains the address of a pointer to the description string that compares the second property with the first property. The string is null-terminated.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method is influenced by the relativeDescriptionType attribute of the displayInfo element in the property's .propdesc file.

It is the responsibility of the calling application to release ppszDesc1 and ppszDesc2 through CoTaskMemFree when they are no longer needed.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Propsys.h

IDL

Propsys.idl

See also

IPropertyDescription
Property Description Schema

 

 

Community Additions

ADD
Show:
© 2014 Microsoft