Função PSGetPropertyDescriptionByName (propsys.h)

Obtém uma instância de uma interface de descrição de propriedade para um nome de propriedade especificado.

Sintaxe

PSSTDAPI PSGetPropertyDescriptionByName(
  [in]  LPCWSTR pszCanonicalName,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Parâmetros

[in] pszCanonicalName

Tipo: LPCWSTR

Um ponteiro para uma cadeia de caracteres Unicode terminada em nulo que identifica a propriedade .

[in] riid

Tipo: REFIID

Referência à ID da interface da propriedade 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.

Valor retornado

Tipo: PSSTDAPI

Retorna um dos valores a seguir.

Comentários

É recomendável 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, eliminando a possibilidade de um erro de codificação.

Recomendamos que pszCanonicalName aponte para o nome canônico de uma propriedade, por exemplo, L"System.Keywords". O nome canônico diferencia maiúsculas de minúsculas.

Além dos novos nomes canônicos, os chamadores podem passar um nome herdado para uma propriedade. A tabela a seguir contém a lista completa de nomes herdados com suporte e os nomes canônicos aos qual eles correspondem.

Exemplos

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

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescriptionByName(L"System.Rating", IID_PPV_ARGS(&pPropDesc))

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

Requisitos

Confira também

IPropertySystem

PSGetPropertyDescription