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 範例程式代碼，請參閱下表。

檔案	Function	Comment
MAPIProgress.cpp	CMAPIProgress：：GetFlags	MFCMAPI 會使用 IMAPIProgress：：GetFlags 方法來判斷已設定的旗標。 除非使用 IMAPIProgress：：SetLimits 方法設定旗標，否則傳回MAPI_TOP_LEVEL。

另請參閱

IMAPIProgress：：SetLimits
IMAPIProgress：IUnknownMFCMAPI 作為程式碼範例
顯示進度指標
實作進度指標