IMAPIProgress::GetMax
適用対象: Outlook 2013 | Outlook 2016
進行状況情報が表示される操作の項目の最大数を返します。
HRESULT GetMax(
ULONG FAR * lpulMax
);
パラメーター
lpulMax
[out]操作内の項目の最大数へのポインター。
戻り値
S_OK
操作内の項目の最大数が取得されました。
注釈
最大値は、操作の終了を数値形式で表します。 値は、進行状況の表示全体の範囲を示すために使用されるグローバルな最大値、あるいは表示の一部のみを示すのに使用されるローカル値になります。
フラグ設定の値は、進行状況オブジェクトがローカルまたはグローバルの最大値を認識するかどうかに影響します。 MAPI_TOP_LEVEL フラグが設定されている場合、最大値はグローバルと見なされ、操作全体の進行状況を計算するために使用されます。 MAPI_TOP_LEVELが設定されていない場合、最大値はローカルと見なされ、プロバイダーはそれを内部的に使用して下位レベルのサブオブジェクトの進行状況を表示します。 進行状況オブジェクトは、 GetMax 呼び出しを介してプロバイダーに返すためにのみ、ローカル最大値を保存します。
進行状況オブジェクトを呼び出す方法とタイミングの詳細については、「進行状況インジケーターを表示する」を参照してください。
実装に関するメモ
最大値を 1000 に初期化します。 サービス プロバイダーは、IMAPIProgress::SetLimits メソッドを呼び出してこの値をリセットできます。 GetMax とその他の IMAPIProgress メソッドを実装する方法の詳細については、「進行状況インジケーターの実装」を参照してください。
MFCMAPI リファレンス
MFCMAPI のサンプル コードについては、次の表を参照してください。
| ファイル | 関数 | コメント |
|---|---|---|
| MAPIProgress.cpp |
CMAPIProgress::GetMax |
MFCMAPI では、 IMAPIProgress::GetMax メソッドを使用して、進行状況オブジェクトの最大値を取得します。 IMAPIProgress::SetLimits メソッドで制限が以前に設定されていない限り、1000 を返します。 |