Método IPropertyDescription::GetRelativeDescription (propsys.h)

Compara dois valores de propriedade da maneira especificada pela descrição da propriedade. Retorna duas cadeias de caracteres de exibição que descrevem como as duas propriedades se comparam.

Sintaxe

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

Parâmetros

[in] propvar1

Tipo: REFPROPVARIANT

Uma referência a uma estrutura PROPVARIANT que contém o tipo e o valor da primeira propriedade.

[in] propvar2

Tipo: REFPROPVARIANT

Uma referência a uma estrutura PROPVARIANT que contém o tipo e o valor da segunda propriedade.

[out] ppszDesc1

Tipo: LPWSTR*

Quando esse método retorna, contém o endereço de um ponteiro para a cadeia de caracteres de descrição que compara a primeira propriedade com a segunda propriedade. A cadeia de caracteres é terminada em nulo.

[out] ppszDesc2

Tipo: LPWSTR*

Quando esse método retorna, contém o endereço de um ponteiro para a cadeia de caracteres de descrição que compara a segunda propriedade com a primeira propriedade. A cadeia de caracteres é terminada em nulo.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Esse método é influenciado pelo atributo relativeDescriptionType do elemento displayInfo no arquivo .propdesc da propriedade.

É responsabilidade do aplicativo de chamada liberar ppszDesc1 e ppszDesc2 por meio de CoTaskMemFree quando eles não forem mais necessários.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	propsys.h

Confira também

IPropertyDescription

Esquema de descrição da propriedade