IMAPIProp::GetPropList

Article
04/04/2023

S’applique à : Outlook 2013 | Outlook 2016

Retourne des balises de propriété pour toutes les propriétés.

HRESULT GetPropList(
  ULONG ulFlags,
  LPSPropTagArray FAR * lppPropTagArray
);

Paramètres

ulFlags

[in] Masque de bits d’indicateurs qui contrôle le format des chaînes dans les balises de propriété retournées. L’indicateur suivant peut être défini :

MAPI_UNICODE

Les chaînes retournées sont au format Unicode. Si l’indicateur MAPI_UNICODE n’est pas défini, les chaînes sont au format ANSI.

lppPropTagArray

[out] Pointeur vers un pointeur vers le tableau de balises de propriété qui contient des balises pour toutes les propriétés de l’objet.

Valeur renvoyée

S_OK

Toutes les balises de propriété ont été retournées avec succès.

MAPI_E_BAD_CHARWIDTH

Soit l’indicateur MAPI_UNICODE a été défini et l’implémentation ne prend pas en charge Unicode, soit MAPI_UNICODE n’a pas été défini et l’implémentation prend uniquement en charge Unicode.

Remarques

La méthode IMAPIProp ::GetPropList récupère la balise de propriété pour chaque propriété actuellement prise en charge par un objet . Si l’objet ne prend actuellement en charge aucune propriété, GetPropList renvoie un tableau de balises de propriétés avec le membre cValues défini sur 0.

L’étendue des propriétés retournées par GetPropList varie d’un fournisseur à l’autre. Certains fournisseurs de services excluent les propriétés pour lesquelles l’appelant n’a pas accès. Tous les fournisseurs retournent des propriétés de type PT_OBJECT.

Si l’objet ne prend pas en charge Unicode, GetPropList renvoie MAPI_E_BAD_CHARWIDTH, même si aucune propriété de chaîne n’est définie pour l’objet.

Remarques pour les responsables de l’implémentation

Les fournisseurs de transport distants implémentent GetPropList exactement comme spécifié ici. Il n’y a pas de préoccupation particulière. Votre implémentation doit bien sûr retourner la même liste de propriétés que celle prise en charge par la méthode IMAPIProp ::GetProps .

Remarques pour les appelants

Appelez la fonction MAPIFreeBuffer pour libérer le tableau de balises de propriété pointé par lppPropTagArray.

Référence MFCMAPI

Pour voir un exemple de code MFCMAPI, consultez le tableau suivant.

Fichier	Fonction	Commentaire
MAPIFunctions.cpp	GetPropsNULL	MFCMAPI utilise la méthode IMAPIProp ::GetPropList pour obtenir une liste de propriétés à transmettre à GetProps.

Voir aussi

IMAPIProp::GetProps
MAPIFreeBuffer
IMAPIProp : IUnknown MFCMAPI en tant qu’exemple de code

Partager via