Função PSGetNameFromPropertyKey (propsys.h)

Recupera o nome canônico da propriedade , considerando sua PROPERTYKEY.

Sintaxe

PSSTDAPI PSGetNameFromPropertyKey(
  [in]  REFPROPERTYKEY propkey,
  [out] PWSTR          *ppszCanonicalName
);

Parâmetros

[in] propkey

Tipo: REFPROPERTYKEY

Referência a uma estrutura PROPERTYKEY que identifica a propriedade solicitada.

[out] ppszCanonicalName

Tipo: PWSTR*

Quando essa função retorna, contém um ponteiro para o nome da propriedade como uma cadeia de caracteres Unicode terminada em nulo.

Retornar valor

Tipo: HRESULT

Retorna um dos valores a seguir.

Comentários

Recupera um nome canônico para uma chave de propriedade especificada. Assim como as chaves de propriedade, os nomes canônicos identificam exclusivamente uma propriedade. Por exemplo, System.Keywords é o nome canônico para PKEY_Keywords. Essa função é bem-sucedida apenas para propriedades registradas como parte do esquema de propriedade.

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

Exemplos

O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PSGetNameFromPropertyKey para ler um valor do armazenamento de propriedades serializado.

PWSTR pszName;

HRESULT hr = PSGetNameFromPropertyKey(PKEY_Keywords, &pszName);

if (SUCCEEDED(hr))
{
    // pszName now contains L"System.Keywords"
 
    CoTaskMemFree(pszName);
}

Requisitos

Confira também

IPropertyDescription::GetCanonicalName

PSGetPropertyDescriptionByName

PSGetPropertyKeyFromName

PSStringFromPropertyKey