Función PSGetPropertyKeyFromName (propsys.h)
Obtiene la clave de propiedad de un nombre de propiedad canónico.
Sintaxis
PSSTDAPI PSGetPropertyKeyFromName(
[in] PCWSTR pszName,
[out] PROPERTYKEY *ppropkey
);
Parámetros
[in] pszName
Tipo: PCWSTR
Puntero a un nombre de propiedad como una cadena Unicode terminada en null.
[out] ppropkey
Tipo: PROPERTYKEY*
Cuando se devuelve esta función, contiene la clave de propiedad solicitada.
Valor devuelto
Tipo: HRESULT
Devuelve uno de los valores siguientes.
Código devuelto | Descripción |
---|---|
|
Se obtuvo la estructura de clave de propiedad. |
|
El parámetro pszName es NULL. |
|
El nombre de la propiedad canónica no existe en la memoria caché del subsistema de esquema. |
Comentarios
Las claves de propiedad identifican de forma única una propiedad. Por ejemplo, PKEY_Keywords
corresponde a System.Keywords
. Esta función solo se realiza correctamente para las propiedades registradas como parte del esquema de propiedades.
Consulte PSGetPropertyDescriptionByName para obtener una lista de nombres de propiedad heredados que también son compatibles con la función.
Ejemplos
En el ejemplo siguiente, para incluirse como parte de un programa más grande, se muestra cómo usar PSGetPropertyKeyFromName para obtener la clave de propiedad para System.Keywords
.
PROPERTYKEY key;
HRESULT hr = PSGetPropertyKeyFromName(L"System.Keywords", &key);
if (SUCCEEDED(hr))
{
// The property key is now valid.
}
Requisitos
Requisito | Value |
---|---|
Cliente mínimo compatible | Windows XP con SP2, Windows Vista [solo aplicaciones de escritorio] |
Servidor mínimo compatible | Windows Server 2003 con SP1 [solo aplicaciones de escritorio] |
Plataforma de destino | Windows |
Encabezado | propsys.h |
Library | Propsys.lib |
Archivo DLL | Propsys.dll (versión 6.0 o posterior) |
Redistribuible | Windows Desktop Search (WDS) 3.0 |