IPerPropertyBrowsing ::GetPredefinedValue, méthode (ocidl.h)

Article
03/04/2024

Récupère la valeur de la propriété spécifiée associée à un nom de chaîne prédéfini. Cette propriété est associée à un nom de chaîne prédéfini retourné par IPerPropertyBrowsing ::GetPredefinedStrings. La chaîne prédéfinie est identifiée par un jeton retourné par GetPredefinedStrings.

Syntaxe

HRESULT GetPredefinedValue(
  [in]  DISPID  dispID,
  [in]  DWORD   dwCookie,
  [out] VARIANT *pVarOut
);

Paramètres

[in] dispID

Identificateur de répartition de la propriété pour laquelle une valeur prédéfinie est demandée.

[in] dwCookie

Jeton identifiant la valeur à retourner. Le jeton a été précédemment retourné dans le tableau pCaCookiesOut rempli par GetPredefinedStrings.

[out] pVarOut

Pointeur vers la valeur VARIANT de la propriété .

Valeur retournée

Cette méthode peut retourner les valeurs de retour standard E_INVALIDARG, E_OUTOFMEMORY et E_UNEXPECTED, ainsi que les valeurs suivantes.

Code de retour	Description
S_OK	La commande s'est correctement terminée.
E_NOTIMPL	Cet objet ne prend pas en charge les chaînes prédéfinies ou les valeurs prédéfinies.
E_POINTER	L’adresse dans pVarOut n’est pas valide. Par exemple, il peut être NULL.

Remarques

Notes aux appelants

L’appelant est responsable de libérer toutes les allocations contenues dans le VARIANT. À moins que le membre vt de VARIANT ne soit VT_VARIANT, l’appelant peut libérer de la mémoire à l’aide d’un seul appel à VariantClear. Sinon, l’appelant doit libérer de manière récursive les valeurs VARIANT contenues avant de libérer le VARIANT externe.

Notes aux implémenteurs

La prise en charge des noms et des valeurs prédéfinis n’est pas requise. Si votre objet ne prend pas en charge ces noms, retournez E_NOTIMPL à partir de cette méthode. Si cette méthode n’est pas implémentée, IPerPropertyBrowsing ::GetPredefinedStrings ne doit pas non plus être implémenté.

Cette méthode alloue toute la mémoire nécessaire à l’intérieur du VARIANT.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	ocidl.h

Voir aussi

Navigation IPerProperty

Partager via