Fonction PSGetPropertyDescription (propsys.h)

Article
03/13/2024

Obtient une instance d’une interface de description de propriété pour une propriété spécifiée par une structure PROPERTYKEY.

Syntaxe

PSSTDAPI PSGetPropertyDescription(
  [in]  REFPROPERTYKEY propkey,
  [in]  REFIID         riid,
  [out] void           **ppv
);

Paramètres

[in] propkey

Type : REFPROPERTYKEY

Référence à un PROPERTYKEY.

[in] riid

Type : REFIID

Référence à l’ID d’interface de l’interface demandée.

[out] ppv

Type : void**

Lorsque cette fonction retourne, contient le pointeur d’interface demandé dans riid. Il s’agit généralement d’IPropertyDescription, IPropertyDescriptionAliasInfo ou IPropertyDescriptionSearchInfo.

Valeur retournée

Type : PSSTDAPI

Retourne l’une des valeurs suivantes.

Code de retour	Description
S_OK	L’interface a été obtenue.
E_INVALIDARG	Le paramètre ppv est NULL.
TYPE_E_ELEMENTNOTFOUND	PropertyKEY n’existe pas dans le cache du sous-système de schéma.

Remarques

Nous vous recommandons d’utiliser la macro IID_PPV_ARGS , définie dans Objbase.h, pour empaqueter les paramètres riid et ppv . Cette macro fournit l’IID correct en fonction de l’interface pointée vers la valeur dans ppv, ce qui élimine la possibilité d’une erreur de codage.

Exemples

L’exemple suivant, à inclure dans le cadre d’un programme plus grand, montre comment utiliser PSGetPropertyDescription pour obtenir la description de la propriété ratings.

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescription(PKEY_Ratings, IID_PPV_ARGS(&pPropDesc));

if (SUCCEEDED(hr))
{
    // pPropDesc is now valid.
 
    pPropDesc->Release();
}

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

PSGetPropertyDescriptionByName

PSGetPropertySystem

Partager via