Méthode IPropertyBag ::Read (oaidl.h)

Article
03/06/2024

Lit la propriété nommée dans un VARIANT initialisé par l’appelant.

Syntaxe

HRESULT Read(
  LPCOLESTR pszPropName,
  VARIANT   *pVar,
  IErrorLog *pErrorLog
);

Paramètres

pszPropName

Adresse du nom de la propriété à lire. Il ne peut pas s’agir de NULL.

pVar

Adresse du VARIANT initialisé par l’appelant qui reçoit la valeur de propriété lors de la sortie. La fonction définit le champ de type et le champ de valeur dans le VARIANT avant qu’il ne retourne. Si l’appelant a initialisé le pVar->vt champ lors de l’entrée, le conteneur de propriétés tente de remplacer sa valeur correspondante par ce type. Si l’appelant définit sur pVar->vt VT_EMPTY, le conteneur de propriétés peut utiliser le type qui convient.

pErrorLog

Adresse du journal des erreurs de l’appelant dans lequel le conteneur de propriétés stocke les erreurs qui se produisent pendant les lectures. Il peut s’agir de NULL ; Dans ce cas, l’appelant ne reçoit pas d’erreurs.

Valeur retournée

Un HRESULT

Remarques

La méthode Read indique au conteneur de propriétés de lire la propriété nommée dans pszPropName dans le VARIANT initialisé par l’appelant dans pVar. Les erreurs sont enregistrées dans le journal des erreurs pointé par pErrorLog. Lorsque pVar->vt spécifie un autre pointeur d’objet (VT_UNKNOWN), le conteneur de propriétés est chargé de créer et d’initialiser l’objet décrit par pszPropName.

E_NOTIMPL n’est pas un code de retour valide, car tout objet qui implémente cette interface doit prendre en charge l’ensemble des fonctionnalités de l’interface.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 10 Build 20348
Serveur minimal pris en charge	Windows 10 Build 20348
En-tête	oaidl.h

Partager via