IMAPIProgress::GetFlags

Статья
04/04/2023

Область применения: Outlook 2013 | Outlook 2016

Возвращает параметры флага из объекта progress для уровня операции, на котором вычисляются сведения о ходе выполнения.

HRESULT GetFlags(
  ULONG FAR * lpulFlags
);

Параметры

lpulFlags

[out] Битовая маска флагов, управляющая уровнем операции, по которой вычисляются сведения о ходе выполнения. Можно вернуть следующий флаг:

MAPI_TOP_LEVEL

Выполняется вычисление хода выполнения для объекта верхнего уровня— объекта, вызываемого клиентом для начала операции. Например, объект верхнего уровня в операции копирования папок — это папка, которая копируется. Если MAPI_TOP_LEVEL не задано, выполняется вычисление хода выполнения для объекта более низкого уровня или подобъекта. В операции копирования папок объект нижнего уровня является одной из вложенных папок в копируемой папке.

Возвращаемое значение

S_OK

Значение флагов было возвращено успешно.

Замечания

MAPI позволяет поставщикам служб различать объекты верхнего уровня и подобъекты с помощью флага MAPI_TOP_LEVEL, чтобы все объекты, участвующие в операции, могли использовать одну и ту же реализацию IMAPIProgress для отображения хода выполнения. Это приводит к плавному отображению индикатора в одном положительном направлении. Установка флага MAPI_TOP_LEVEL определяет, как поставщики служб задают другие параметры в последующих вызовах объекта progress.

Значение, возвращаемое Командой GetFlags , задается сначала реализутелем, а затем поставщиком услуг посредством вызова метода IMAPIProgress::SetLimits .

Примечания для исполнителей

Всегда инициализируйте флаг, чтобы MAPI_TOP_LEVEL, а затем по мере необходимости снимите его с помощью поставщиков услуг. Поставщики услуг могут очистить и сбросить флаг, вызвав метод IMAPIProgress::SetLimits . Дополнительные сведения о реализации GetFlags и других методов IMAPIProgress см. в разделе Реализация индикатора хода выполнения.

Примечания для вызывающих методов

При отображении индикатора хода выполнения выполните первый вызов IMAPIProgress::GetFlags. Возвращаемое значение должно быть MAPI_TOP_LEVEL, так как все реализации инициализируют содержимое параметра lpulFlags этим значением. Дополнительные сведения о последовательности вызовов объекта выполнения см. в разделе Отображение индикатора хода выполнения.

Справочные материалы по MFCMAPI

Пример кода MFCMAPI указан в приведенной ниже таблице.

Файл	Функция	Примечание
MAPIProgress.cpp	CMAPIProgress::GetFlags	MFCMAPI использует метод IMAPIProgress::GetFlags для определения установленных флагов. Возвращает MAPI_TOP_LEVEL, если флаги не заданы с помощью метода IMAPIProgress::SetLimits .

См. также

IMAPIProgress::SetLimits
IMAPIProgress: IUnknown MFCMAPI как пример кода
Отображение индикатора хода выполнения
Реализация индикатора хода выполнения

Поделиться через