IMAPIProgress::GetFlags

适用于：Outlook 2013 | Outlook 2016

从进度对象返回计算进度信息的操作级别的标志设置。

HRESULT GetFlags(
  ULONG FAR * lpulFlags
);

参数

lpulFlags

[out]标志的位掩码，用于控制计算进度信息的操作级别。 可以返回以下标志：

MAPI_TOP_LEVEL

正在计算顶级对象（客户端调用以开始操作的对象）的进度。 例如，文件夹复制操作中的顶级对象是正在复制的文件夹。 如果未设置MAPI_TOP_LEVEL，则会为较低级别的对象或子对象计算进度。 在文件夹复制操作中，较低级别的对象是正在复制的文件夹中的子文件夹之一。

返回值

S_OK

已成功返回标志值。

备注

MAPI 使服务提供程序能够使用 MAPI_TOP_LEVEL 标志区分顶级对象和子对象，以便操作中涉及的所有对象都可以使用相同的 IMAPIProgress 实现来显示进度。 这会导致指示器显示在单个正方向上顺利进行。 是否设置MAPI_TOP_LEVEL标志决定了服务提供商在后续调用进度对象时如何设置其他参数。

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：IUnknownMFCMAPI 作为代码示例
显示进度指示器
实现进度指示器