IMAPIProgress::GetFlags

S’applique à : Outlook 2013 | Outlook 2016

Retourne les paramètres d’indicateur de l’objet progress pour le niveau d’opération sur lequel les informations de progression sont calculées.

HRESULT GetFlags(
  ULONG FAR * lpulFlags
);

Paramètres

lpulFlags

[out] Masque de bits d’indicateurs qui contrôle le niveau d’opération sur lequel les informations de progression sont calculées. L’indicateur suivant peut être retourné :

MAPI_TOP_LEVEL

La progression est calculée pour l’objet de niveau supérieur, l’objet appelé par le client pour commencer l’opération. Par exemple, l’objet de niveau supérieur dans une opération de copie de dossier est le dossier en cours de copie. Lorsque MAPI_TOP_LEVEL n’est pas défini, la progression est calculée pour un objet de niveau inférieur ou un sous-objet. Dans l’opération de copie de dossier, un objet de niveau inférieur est l’un des sous-dossiers du dossier qui est copié.

Valeur renvoyée

S_OK

La valeur des indicateurs a été retournée avec succès.

Remarques

MAPI permet aux fournisseurs de services de faire la distinction entre les objets de niveau supérieur et les sous-objets avec l’indicateur MAPI_TOP_LEVEL afin que tous les objets impliqués dans une opération puissent utiliser la même implémentation IMAPIProgress pour afficher la progression. L’affichage de l’indicateur se déroule ainsi sans heurts dans une seule direction positive. Si l’indicateur MAPI_TOP_LEVEL est défini, détermine comment les fournisseurs de services définissent les autres paramètres dans les appels suivants à l’objet progress.

La valeur retournée par GetFlags est définie initialement par l’implémenteur, puis par le fournisseur de services via un appel à la méthode IMAPIProgress ::SetLimits .

Remarques pour les responsables de l’implémentation

Initialisez toujours l’indicateur pour MAPI_TOP_LEVEL, puis appuyez-vous sur les fournisseurs de services pour l’effacer le cas échéant. Les fournisseurs de services peuvent effacer et réinitialiser l’indicateur en appelant la méthode IMAPIProgress ::SetLimits . Pour plus d’informations sur l’implémentation de GetFlags et des autres méthodes IMAPIProgress , consultez Implémentation d’un indicateur de progression.

Remarques pour les appelants

Lorsque vous affichez un indicateur de progression, effectuez votre premier appel à IMAPIProgress ::GetFlags. La valeur retournée doit être MAPI_TOP_LEVEL, car toutes les implémentations initialisent le contenu du paramètre lpulFlags à cette valeur. Pour plus d’informations sur la séquence d’appels à un objet progress, consultez Afficher un indicateur de progression.

Référence MFCMAPI

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

Fichier	Fonction	Commentaire
MAPIProgress.cpp	CMAPIProgress ::GetFlags	MFCMAPI utilise la méthode IMAPIProgress ::GetFlags pour déterminer les indicateurs définis. Retourne MAPI_TOP_LEVEL sauf si des indicateurs ont été définis à l’aide de la méthode IMAPIProgress ::SetLimits .

Voir aussi

IMAPIProgress::SetLimits
IMAPIProgress : IUnknownMFCMAPI en tant qu’exemple de code
Affichage d’un indicateur de progression
Implémentation d’un indicateur de progression