PSGetNameFromPropertyKey, fonction (propsys.h)

  • Article

Récupère le nom canonique de la propriété, en fonction de son PROPERTYKEY.

Syntaxe

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

Paramètres

[in] propkey

Type : REFPROPERTYKEY

Référence à une structure PROPERTYKEY qui identifie la propriété demandée.

[out] ppszCanonicalName

Type : PWSTR*

Lorsque cette fonction est retournée, contient un pointeur vers le nom de la propriété sous la forme d’une chaîne Unicode terminée par null.

Valeur retournée

Type : HRESULT

Retourne l’une des valeurs suivantes.

Code de retour Description
S_OK
 Le nom canonique de la propriété est obtenu.
TYPE_E_ELEMENTNOTFOUND
 Indique que propertyKEY n’existe pas dans le cache du sous-système de schéma.

Remarques

Récupère un nom canonique pour une clé de propriété spécifiée. Comme les clés de propriété, les noms canoniques identifient une propriété de manière unique. Par exemple, System.Keywords est le nom canonique pour PKEY_Keywords. Cette fonction réussit uniquement pour les propriétés inscrites dans le cadre du schéma de propriété.

Il incombe à l’application appelante d’utiliser CoTaskMemFree pour libérer la chaîne référencée par ppszCanonicalName quand elle n’est plus nécessaire.

Exemples

L’exemple suivant, à inclure dans le cadre d’un programme plus large, montre comment utiliser PSGetNameFromPropertyKey pour lire une valeur à partir du stockage de propriétés sérialisées.

PWSTR pszName;

HRESULT hr = PSGetNameFromPropertyKey(PKEY_Keywords, &pszName);

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

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP avec SP2, Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 avec SP1 [applications de bureau uniquement]
Plateforme cible Windows
En-tête propsys.h
Bibliothèque Propsys.lib
DLL Propsys.dll (version 6.0 ou ultérieure)
Composant redistribuable Windows Desktop Search (WDS) 3.0

Voir aussi

IPropertyDescription ::GetCanonicalName

PSGetPropertyDescriptionByName

PSGetPropertyKeyFromName

PSStringFromPropertyKey