Fonction PSGetPropertyKeyFromName (propsys.h)

Article
03/04/2024

Obtient la clé de propriété d’un nom de propriété canonique.

Syntaxe

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

Paramètres

[in] pszName

Type : PCWSTR

Pointeur vers un nom de propriété sous la forme d’une chaîne Unicode terminée par null.

[out] ppropkey

Type : PROPERTYKEY*

Lorsque cette fonction retourne, contient la clé de propriété demandée.

Valeur retournée

Type : HRESULT

Retourne l’une des valeurs suivantes.

Code de retour	Description
S_OK	La structure de clé de propriété a été obtenue.
E_INVALIDARG	Le paramètre pszName est NULL.
TYPE_E_ELEMENTNOTFOUND	Le nom de la propriété canonique n’existe pas dans le cache du sous-système de schéma.

Remarques

Les clés de propriété identifient une propriété de manière unique. Par exemple, PKEY_Keywords correspond à System.Keywords. Cette fonction réussit uniquement pour les propriétés inscrites dans le cadre du schéma de propriété.

Consultez PSGetPropertyDescriptionByName pour obtenir la liste des noms de propriétés hérités qui sont également pris en charge par la fonction.

Exemples

L’exemple suivant, à inclure dans le cadre d’un programme plus grand, montre comment utiliser PSGetPropertyKeyFromName pour obtenir la clé de propriété pour System.Keywords.

PROPERTYKEY key;

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

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

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