IMAPIProgress::GetMax
Область применения: Outlook 2013 | Outlook 2016
Возвращает максимальное количество элементов в операции, для которой отображаются сведения о ходе выполнения.
HRESULT GetMax(
ULONG FAR * lpulMax
);
Параметры
lpulMax
[out] Указатель на максимальное количество элементов в операции.
Возвращаемое значение
S_OK
Максимальное количество элементов в операции было извлечено.
Замечания
Максимальное значение представляет конец операции в числовой форме. Оно может быть глобальным максимальным значением, представляющим отображаемые данные всего хода выполнения, или локальным значением, представляющим только часть отображаемых данных.
Значение параметра флага влияет на то, понимает ли объект выполнения максимальное значение, которое должно быть локальным или глобальным. При установке флага MAPI_TOP_LEVEL максимальное значение считается глобальным и используется для вычисления хода выполнения всей операции. Если MAPI_TOP_LEVEL не задано, максимальное значение считается локальным, и поставщики используют его внутренне для отображения хода выполнения для подобъектов более низкого уровня. Объекты выполнения сохраняют локальное максимальное значение только для возврата его поставщику через вызов GetMax .
Дополнительные сведения о том, как и когда выполнять вызовы объекта хода выполнения, см. в статье Отображение индикатора хода выполнения.
Примечания для исполнителей
Инициализируйте максимальное значение 1000. Поставщики службы могут сбросить это значение путем вызова метода IMAPIProgress::SetLimits. Дополнительные сведения о реализации GetMax и других методов IMAPIProgress см. в разделе Реализация индикатора хода выполнения.
Справочные материалы по MFCMAPI
Пример кода MFCMAPI указан в приведенной ниже таблице.
| Файл | Функция | Примечание |
|---|---|---|
| MAPIProgress.cpp |
CMAPIProgress::GetMax |
MFCMAPI использует метод IMAPIProgress::GetMax для получения максимального значения объекта progress. Возвращает значение 1000, если ранее не были установлены ограничения с помощью метода IMAPIProgress::SetLimits . |