Función PSGetNameFromPropertyKey (propsys.h)

Artículo
03/01/2024

Recupera el nombre canónico de la propiedad, dado su PROPERTYKEY.

Sintaxis

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

Parámetros

[in] propkey

Tipo: REFPROPERTYKEY

Referencia a una estructura PROPERTYKEY que identifica la propiedad solicitada.

[out] ppszCanonicalName

Tipo: PWSTR*

Cuando esta función vuelve, contiene un puntero al nombre de propiedad como una cadena Unicode terminada en null.

Valor devuelto

Tipo: HRESULT

Devuelve uno de los valores siguientes.

Código devuelto	Descripción
S_OK	Se obtiene el nombre canónico de la propiedad.
TYPE_E_ELEMENTNOTFOUND	Indica que propertykey no existe en la memoria caché del subsistema de esquema.

Comentarios

Recupera un nombre canónico para una clave de propiedad especificada. Al igual que las claves de propiedad, los nombres canónicos identifican de forma única una propiedad. Por ejemplo, System.Keywords es el nombre canónico de PKEY_Keywords. Esta función solo se realiza correctamente para las propiedades registradas como parte del esquema de propiedades.

Es responsabilidad de la aplicación que realiza la llamada usar CoTaskMemFree para liberar la cadena a la que hace referencia ppszCanonicalName cuando ya no es necesaria.

Ejemplos

En el ejemplo siguiente, para incluirse como parte de un programa más grande, se muestra cómo usar PSGetNameFromPropertyKey para leer un valor del almacenamiento de propiedades serializado.

PWSTR pszName;

HRESULT hr = PSGetNameFromPropertyKey(PKEY_Keywords, &pszName);

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

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