IMAPIProgress::P rogress
適用於:Outlook 2013 |Outlook 2016
匯報 進度指標,並顯示作業完成時的進度。
HRESULT Progress(
ULONG ulValue,
ULONG ulCount,
ULONG ulTotal
);
參數
ulValue
[in]一個數位,表示從ulCount和ulTotal參數,或從IMAPIProgress::SetLimits方法的 lpulMin 和 lpulMax 參數計算 (目前進度層級,) 全域下限和全域上限之間。
ulCount
[in]數位,表示目前處理的專案相對於總計。
ulTotal
[in]作業期間要處理的項目總數。
傳回值
S_OK
進度指示器已成功更新。
實作者注意事項
ulValue 參數只會在作業開始時等於全域最小值,並且只在作業完成時等於全域最大值。
如果有的話,請使用 ulCount 和 ulTotal 參數來顯示選擇性訊息,例如「10 個專案中有 5 個專案完成」。如果 ulCount 和 ulTotal 設定為 0,請決定是否要以可視化方式變更進度指示器。 某些服務提供者會將這些參數設定為 0,表示它們正在處理相對於父物件監視進度的子物件。 在此情況下,只有在父物件報告進度時,才變更顯示器是合理的。 有些服務提供者每次都會針對這些參數傳遞 0。
如需如何實作 Progress 和其他 IMAPIProgress 方法的詳細資訊,請參閱 實作進度指示器。
呼叫者注意事項
並非 IMAPIProgress::P rogress 的所有三個參數都是必要的。 唯一需要的參數是 ulValue,這是指出進度百分比的數位。 如果已設定MAPI_TOP_LEVEL旗標,您也可以傳遞物件計數和對象總計。 某些實作會使用這些值來顯示片語,例如「完成10個專案中的5個專案」,以及進度指示器。
如果您要複製單一資料夾中的所有訊息,請將 ulTotal 設定為要複製的訊息總數。 如果您要複製資料夾,請將 ulTotal 設定為資料夾中的子資料夾數目。 如果要複製的資料夾不包含任何子資料夾和訊息,請將 ulTotal 設定為1。
如需如何及何時呼叫進度對象的詳細資訊,請參閱 顯示進度指示器。
MFCMAPI 參考
如需 MFCMAPI 範例程式代碼,請參閱下表。
檔案 | Function | Comment |
---|---|---|
MAPIProgress.cpp |
CMAPIProgress::P rogress |
MFCMAPI 會使用 IMAPIProgress::P rogress 方法,以目前進度百分比更新 MFCMAPI 狀態列,該百分比是從 uValue 計算而來,以及目前的最大值和最小值。 |