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.
| Código de retorno | Descrição |
|---|---|
|
A estrutura da chave de propriedade foi obtida. |
|
O parâmetro pszName é NULL. |
|
O nome da propriedade canônica não existe no cache do subsistema de esquema. |
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
| 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 |
| Biblioteca | Propsys.lib |
| DLL | Propsys.dll (versão 6.0 ou posterior) |
| Redistribuível | Pesquisa da Área de Trabalho do Windows (WDS) 3.0 |