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

Obtém o nome de exibição da propriedade como ela é mostrada em qualquer interface do usuário.

Sintaxe

HRESULT GetDisplayName(
  [out] LPWSTR *ppszName
);

Parâmetros

[out] ppszName

Tipo: LPWSTR*

Contém o endereço de um ponteiro para o nome da propriedade como uma cadeia de caracteres Unicode terminada em nulo.

Valor retornado

Tipo: HRESULT

Retorna um dos valores a seguir.

Código de retorno	Descrição
S_OK	O nome de exibição é obtido.
E_INVALIDARG	O parâmetro ppszDisplayName é NULL.
E_OUTOFMEMORY	Falha na alocação de memória.

Comentários

As informações recuperadas por esse método vêm dos atributos singularLabel e pluralLabel do elemento labelInfo no arquivo .propdesc da propriedade.

É responsabilidade do aplicativo de chamada usar CoTaskMemFree para liberar a cadeia de caracteres referenciada por ppszDisplayName quando ela não for mais necessária.

Requisitos

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