IMAPIProgress::GetMax

Article
04/04/2023

S’applique à : Outlook 2013 | Outlook 2016

Retourne le nombre maximal d’éléments de l’opération pour lesquels les informations de progression sont affichées.

HRESULT GetMax(
  ULONG FAR * lpulMax
);

Paramètres

lpulMax

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

Valeur renvoyée

S_OK

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

Remarques

La valeur maximale représente la fin de l’opération sous forme 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 détermine si l’objet progress comprend que la valeur maximale soit locale ou globale. Lorsque l’indicateur MAPI_TOP_LEVEL est défini, la valeur maximale est considérée comme globale et utilisée pour calculer la progression de l’ensemble de l’opération. Lorsque MAPI_TOP_LEVEL n’est pas défini, la valeur maximale est considérée comme locale et les fournisseurs l’utilisent en interne pour afficher la progression des sous-objets de niveau inférieur. Les objets Progress enregistrent la valeur maximale locale uniquement pour la renvoyer à un fournisseur via un appel GetMax .

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.

Remarques pour les responsables de l’implémentation

Initialisez la valeur maximale sur 1000. Les fournisseurs de services peuvent réinitialiser cette valeur en appelant la méthode IMAPIProgress::SetLimits. Pour plus d’informations sur l’implémentation de GetMax et des autres méthodes IMAPIProgress , consultez Implémentation 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 ::GetMax	MFCMAPI utilise la méthode IMAPIProgress ::GetMax pour obtenir la valeur maximale de l’objet progress. Retourne 1000, sauf si des limites ont déjà été définies avec la méthode IMAPIProgress ::SetLimits .