IMAPIProgress::Progress
S’applique à : Outlook 2013 | Outlook 2016
Mises à jour l’indicateur de progression avec un affichage de la progression à mesure qu’elle est effectuée vers la fin de l’opération.
HRESULT Progress(
ULONG ulValue,
ULONG ulCount,
ULONG ulTotal
);
Paramètres
ulValue
[in] Nombre qui indique le niveau de progression actuel (calculé à partir des paramètres ulCount et ulTotal ou des paramètres lpulMin et lpulMax de la méthode IMAPIProgress ::SetLimits ) entre la limite inférieure globale et la limite supérieure globale.
ulCount
[in] Nombre qui indique l’élément actuellement traité par rapport au total.
ulTotal
[in] Nombre total d’éléments à traiter pendant l’opération.
Valeur renvoyée
S_OK
L’indicateur de progression a été correctement mis à jour.
Remarques pour les responsables de l’implémentation
Le paramètre ulValue est égal à la valeur minimale globale uniquement au début de l’opération et à la valeur maximale globale uniquement à la fin de l’opération.
Utilisez les paramètres ulCount et ulTotal , le cas échéant, pour afficher un message facultatif tel que « 5 éléments terminés sur 10 ». Si ulCount et ulTotal sont définis sur 0, décidez s’il faut modifier visuellement l’indicateur de progression. Certains fournisseurs de services définissent ces paramètres sur 0 pour indiquer qu’ils traitent un sous-objet dont la progression est surveillée par rapport à un objet parent. Dans ce cas, il est logique de modifier l’affichage uniquement lorsque l’objet parent signale la progression. Certains fournisseurs de services passent 0 pour ces paramètres à chaque fois.
Pour plus d’informations sur la façon d’implémenter Progress et les autres méthodes IMAPIProgress , consultez Implémentation d’un indicateur de progression.
Remarques pour les appelants
Les trois paramètres de IMAPIProgress ::P rogress ne sont pas requis. Le seul paramètre requis est ulValue, un nombre qui indique le pourcentage de progression. Si l’indicateur MAPI_TOP_LEVEL est défini, vous pouvez également passer un nombre d’objets et un total d’objets. Certaines implémentations utilisent ces valeurs pour afficher une expression telle que « 5 éléments terminés sur 10 » avec l’indicateur de progression.
Si vous copiez tous les messages dans un dossier unique, définissez ulTotal sur le nombre total de messages copiés. Si vous copiez un dossier, définissez ulTotal sur le nombre de sous-dossiers dans le dossier. Si le dossier à copier ne contient aucun sous-dossier et uniquement des messages, définissez ulTotal sur 1.
Pour plus d’informations sur la méthode et le moment opportun pour appeler un objet de progression, reportez-vous à Affichage d’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 ::P rogress |
MFCMAPI utilise la méthode IMAPIProgress ::P rogress pour mettre à jour la barre de status MFCMAPI avec le pourcentage actuel de progression, calculé à partir de uValue et des valeurs maximale et minimale actuelles. |
Voir aussi
MFCMAPI en tant qu’exemple de code