IMAPIProgress::GetMin

Article
04/04/2023

S’applique à : Outlook 2013 | Outlook 2016

Renvoie la valeur minimale dans la méthode IMAPIProgress::SetLimits pour laquelle les informations de progression sont affichées.

HRESULT GetMin(
  ULONG FAR * lpulMin
);

Paramètres

lpulMin

[out] Pointeur vers le nombre minimal d’éléments dans l’opération.

Valeur renvoyée

S_OK

Le nombre minimal d’éléments dans l’opération a été récupéré.

Remarques

La valeur minimale représente le début de l’opération au format numérique. La valeur peut être une valeur maximale globale, utilisée pour représenter l’étendue de l’intégralité de l’affichage de la progression, ou une valeur locale, utilisée pour représenter uniquement une partie de l’affichage.

La valeur du paramètre d’indicateur permet de déterminer si l’objet de progression considère la valeur minimale comme locale ou globale. Lorsque l’indicateur MAPI_TOP_LEVEL est défini, la valeur minimale est globale et sert à calculer la progression pour l’intégralité de l’opération. Si MAPI_TOP_LEVEL n’est pas défini, la valeur minimale est locale, et les fournisseurs l’utilisent en interne afin d’afficher la progression pour les sous-objets de niveau inférieur. Les objets de progression enregistrent la valeur minimale locale uniquement pour la renvoyer à un fournisseur par le biais d’un appel GetMin.

Remarques à l’attention des responsables de l’implémentation

Initialisez la valeur minimale sur 1. Les fournisseurs de services peuvent réinitialiser cette valeur en appelant la méthode IMAPIProgress::SetLimits. Pour plus d’informations sur la méthode d’implémentation de la méthode GetMin et des autres méthodes IMAPIProgress, reportez-vous à la rubrique Implémentation d’un indicateur de progression.

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::GetMin	MFCMAPI utilise la méthode IMAPIProgress::GetMin afin d’obtenir la valeur minimale pour l’indicateur de progression. Renvoie la valeur 1 sauf si des limites ont précédemment été définies au moyen de l’appel de la méthode IMAPIProgress::SetLimits.