Função PSGetPropertyKeyFromName (propsys.h)

Obtém a chave de propriedade para um nome de propriedade canônica.

Sintaxe

PSSTDAPI PSGetPropertyKeyFromName(
  [in]  PCWSTR      pszName,
  [out] PROPERTYKEY *ppropkey
);

Parâmetros

[in] pszName

Tipo: PCWSTR

Ponteiro para um nome de propriedade como uma cadeia de caracteres Unicode terminada em nulo.

[out] ppropkey

Tipo: PROPERTYKEY*

Quando essa função retorna, contém a chave de propriedade solicitada.

Retornar valor

Tipo: HRESULT

Retorna um dos valores a seguir.

Comentários

As chaves de propriedade identificam exclusivamente uma propriedade. Por exemplo, PKEY_Keywords corresponde à System.Keywords. Essa função é bem-sucedida apenas para propriedades registradas como parte do esquema de propriedade.

Consulte PSGetPropertyDescriptionByName para obter uma lista de nomes de propriedades herdados que também são compatíveis com a função .

Exemplos

O exemplo a seguir, a ser incluído como parte de um programa maior, demonstra como usar PSGetPropertyKeyFromName para obter a chave de propriedade para System.Keywords.

PROPERTYKEY key;

HRESULT hr = PSGetPropertyKeyFromName(L"System.Keywords", &key);

if (SUCCEEDED(hr))
{
    // The property key is now valid.
}

Requisitos

Confira também

IPropertyDescription::GetPropertyKey

PSGetNameFromPropertyKey

PSGetPropertyDescription

PSPropertyKeyFromString