Função PSGetPropertyDescription (propsys.h)

Obtém uma instância de uma interface de descrição de propriedade para uma propriedade especificada por uma estrutura PROPERTYKEY .

Sintaxe

PSSTDAPI PSGetPropertyDescription(
  [in]  REFPROPERTYKEY propkey,
  [in]  REFIID         riid,
  [out] void           **ppv
);

Parâmetros

[in] propkey

Tipo: REFPROPERTYKEY

Referência a um PROPERTYKEY.

[in] riid

Tipo: REFIID

Referência à ID da interface solicitada.

[out] ppv

Tipo: void**

Quando essa função retorna, contém o ponteiro de interface solicitado em riid. Normalmente, isso é IPropertyDescription, IPropertyDescriptionAliasInfo ou IPropertyDescriptionSearchInfo.

Retornar valor

Tipo: PSSTDAPI

Retorna um dos valores a seguir.

Código de retorno	Descrição
S_OK	A interface foi obtida.
E_INVALIDARG	O parâmetro ppv é NULL.
TYPE_E_ELEMENTNOTFOUND	PROPERTYKEY não existe no cache do subsistema de esquema.

Comentários

Recomendamos que você use a macro IID_PPV_ARGS , definida em Objbase.h, para empacotar os parâmetros riid e ppv . Essa macro fornece o IID correto com base na interface apontada pelo valor em ppv, o que elimina a possibilidade de um erro de codificação.

Exemplos

O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PSGetPropertyDescription para obter a descrição da propriedade ratings.

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescription(PKEY_Ratings, IID_PPV_ARGS(&pPropDesc));

if (SUCCEEDED(hr))
{
    // pPropDesc is now valid.
 
    pPropDesc->Release();
}

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP com SP2, Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 com SP1 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	propsys.h
Biblioteca	Propsys.lib
DLL	Propsys.dll (versão 6.0 ou posterior)
Redistribuível	Pesquisa da Área de Trabalho do Windows (WDS) 3.0

Confira também

PSGetPropertyDescriptionByName

PSGetPropertySystem