IPropertyDescription::GetRelativeDescription method (propsys.h)
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
[in] propvar1
Type: REFPROPVARIANT
A reference to a PROPVARIANT structure that contains the type and value of the first property.
[in] propvar2
Type: REFPROPVARIANT
A reference to a PROPVARIANT structure that contains the type and value of the second property.
[out] ppszDesc1
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.
[out] ppszDesc2
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | propsys.h |