Share via


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

Obtém o nome que diferencia maiúsculas de minúsculas pelo qual uma propriedade é conhecida pelo sistema, independentemente de seu nome localizado.

Sintaxe

HRESULT GetCanonicalName(
  [out] LPWSTR *ppszName
);

Parâmetros

[out] ppszName

Tipo: LPWSTR*

Quando esse método retorna, contém o endereço de um ponteiro para o nome canônico da propriedade como uma cadeia de caracteres Unicode 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

As informações recuperadas por esse método vêm do atributo name do elemento propertyDescription no arquivo .propdesc da propriedade.

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

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