IMAPIProgress::Progress
Область применения: Outlook 2013 | Outlook 2016
Обновления индикатор хода выполнения с отображением хода выполнения операции.
HRESULT Progress(
ULONG ulValue,
ULONG ulCount,
ULONG ulTotal
);
Параметры
ulValue
[в] Число, указывающее текущий уровень хода выполнения (вычисляется на основе параметров ulCount и ulTotal или из параметров lpulMin и lpulMax метода IMAPIProgress::SetLimits ) между глобальным нижним и глобальным верхним пределом.
ulCount
[в] Число, указывающее обрабатываемый элемент относительно общей суммы.
ulTotal
[в] Общее количество элементов, обрабатываемых во время операции.
Возвращаемое значение
S_OK
Индикатор хода выполнения успешно обновлен.
Примечания для исполнителей
Параметр ulValue будет равен глобальному минимальному значению только в начале операции и глобальному максимальному значению только по завершении операции.
Используйте параметры ulCount и ulTotal , если они доступны, чтобы отобразить необязательное сообщение, например "5 элементов завершено из 10". Если для ulCount и ulTotal задано значение 0, решите, следует ли визуально изменять индикатор хода выполнения. Некоторые поставщики услуг устанавливают для этих параметров значение 0, чтобы указать, что они обрабатывают подобъект, ход выполнения которого отслеживается относительно родительского объекта. В этой ситуации имеет смысл изменять отображение только в том случае, если родительский объект сообщает о ходе выполнения. Некоторые поставщики услуг каждый раз передают 0 для этих параметров.
Дополнительные сведения о реализации Progress и других методов IMAPIProgress см. в разделе Реализация индикатора хода выполнения.
Примечания для вызывающих методов
Не все три параметра для IMAPIProgress::P rogress являются обязательными . Единственным обязательным параметром является ulValue, число, указывающее процент хода выполнения. Если флаг MAPI_TOP_LEVEL установлен, можно также передать количество объектов и итог объекта. В некоторых реализациях эти значения используются для отображения фразы, например "5 элементов завершено из 10" с индикатором хода выполнения.
Если вы копируете все сообщения в одной папке, задайте для параметра ulTotal общее количество копируемых сообщений. Если вы копируете папку, задайте для параметра ulTotal количество вложенных папок в папке. Если копируемые папки не содержат вложенных папок и только сообщений, задайте для параметра ulTotal значение 1.
Дополнительные сведения о том, как и когда выполнять вызовы объекта хода выполнения, см. в статье Отображение индикатора хода выполнения.
Справочные материалы по MFCMAPI
Пример кода MFCMAPI указан в приведенной ниже таблице.
| Файл | Функция | Примечание |
|---|---|---|
| MAPIProgress.cpp |
CMAPIProgress::P rogress |
MFCMAPI использует метод IMAPIProgress::P rogress для обновления строки состояния MFCMAPI текущим процентом хода выполнения, вычисляемым на основе uValue и текущих максимальных и минимальных значений. |