Méthode IPropertySystem ::GetPropertyDescriptionByName (propsys.h)

Article
03/09/2024

Obtient une instance de l’objet de sous-système qui implémente IPropertyDescription, pour obtenir la description de la propriété pour un nom canonique donné.

Syntaxe

HRESULT GetPropertyDescriptionByName(
  [in]  LPCWSTR pszCanonicalName,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Paramètres

[in] pszCanonicalName

Type : LPCWSTR

Pointeur vers une chaîne qui identifie la propriété.

[in] riid

Type : REFIID

Référence à l’IID souhaité.

[out] ppv

Type : void**

Adresse d’un pointeur d’interface IPropertyDescription .

Valeur retournée

Type : PSSTDAPI

Retourne l’une des valeurs suivantes.

Code de retour	Description
S_OK	Indique que l’interface est obtenue.
E_INVALIDARG	Indique que pszCanonicalName a la valeur NULL.
TYPE_E_ELEMENTNOTFOUND	Indique que le nom canonique n’existe pas dans le cache du sous-système de schéma.

Remarques

Il est recommandé 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, éliminant ainsi la possibilité d’une erreur de codage.

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
DLL	Propsys.dll (version 5.0 ou ultérieure)
Composant redistribuable	Windows Desktop Search (WDS) 3.0

Voir aussi

IPropertySystem

Partager via