Método IPropertySystem::GetPropertyDescriptionByName (propsys.h)

Obtém uma instância do objeto de subsistema que implementa IPropertyDescription para obter a descrição da propriedade para um determinado nome canônico.

Sintaxe

HRESULT GetPropertyDescriptionByName(
  [in]  LPCWSTR pszCanonicalName,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Parâmetros

[in] pszCanonicalName

Tipo: LPCWSTR

Um ponteiro para uma cadeia de caracteres que identifica a propriedade .

[in] riid

Tipo: REFIID

Uma referência ao IID desejado.

[out] ppv

Tipo: void**

O endereço de um ponteiro de interface IPropertyDescription .

Retornar valor

Tipo: PSSTDAPI

Retorna um dos valores a seguir.

Código de retorno	Descrição
S_OK	Indica que a interface é obtida.
E_INVALIDARG	Indica que pszCanonicalName é NULL.
TYPE_E_ELEMENTNOTFOUND	Indica que o nome canônico não existe no cache do subsistema de esquema.

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.

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
DLL	Propsys.dll (versão 5.0 ou posterior)
Redistribuível	Pesquisa da Área de Trabalho do Windows (WDS) 3.0

Confira também

IPropertySystem