IMAPIProgress::Progress
Gilt für: Outlook 2013 | Outlook 2016
Updates die Statusanzeige mit einer Anzeige des Fortschritts bis zum Abschluss des Vorgangs.
HRESULT Progress(
ULONG ulValue,
ULONG ulCount,
ULONG ulTotal
);
Parameter
ulValue
[in] Eine Zahl, die den aktuellen Fortschritt (berechnet aus den Parametern ulCount und ulTotal oder aus den lpulMin - und lpulMax-Parametern der IMAPIProgress::SetLimits-Methode ) zwischen der globalen Untergrenze und der globalen Obergrenze angibt.
ulCount
[in] Eine Zahl, die das aktuell verarbeitete Element relativ zur Summe angibt.
ulTotal
[in] Die Gesamtanzahl der Elemente, die während des Vorgangs verarbeitet werden sollen.
Rückgabewert
S_OK
Die Statusanzeige wurde erfolgreich aktualisiert.
Hinweise für Implementierer
Der ulValue-Parameter entspricht dem globalen Minimalwert nur zu Beginn des Vorgangs und dem globalen Höchstwert erst nach Abschluss des Vorgangs.
Verwenden Sie die Parameter ulCount und ulTotal , falls verfügbar, um eine optionale Meldung wie "5 Von 10 Elementen abgeschlossen" anzuzeigen. Wenn ulCount und ulTotal auf 0 festgelegt sind, entscheiden Sie, ob die Statusanzeige visuell geändert werden soll. Einige Dienstanbieter legen diese Parameter auf 0 fest, um anzugeben, dass sie ein Unterobjekt verarbeiten, dessen Fortschritt relativ zu einem übergeordneten Objekt überwacht wird. In diesem Fall ist es sinnvoll, die Anzeige nur zu ändern, wenn das übergeordnete Objekt den Fortschritt meldet. Einige Dienstanbieter übergeben für diese Parameter jedes Mal 0.
Weitere Informationen zum Implementieren von Progress und den anderen IMAPIProgress-Methoden finden Sie unter Implementieren eines Statusindikators.
Hinweise für Aufrufer
Nicht alle drei Parameter für IMAPIProgress::P rogress sind erforderlich. Der einzige erforderliche Parameter ist ulValue, eine Zahl, die den Prozentsatz des Fortschritts angibt. Wenn das MAPI_TOP_LEVEL-Flag festgelegt ist, können Sie auch eine Objektanzahl und eine Objektsumme übergeben. Einige Implementierungen verwenden diese Werte, um einen Ausdruck wie "5 von 10 Abgeschlossene Elemente" mit der Statusanzeige anzuzeigen.
Wenn Sie alle Nachrichten in einen einzelnen Ordner kopieren, legen Sie ulTotal auf die Gesamtanzahl der kopierten Nachrichten fest. Wenn Sie einen Ordner kopieren, legen Sie ulTotal auf die Anzahl der Unterordner im Ordner fest. Wenn der zu kopierende Ordner keine Unterordner und nur Nachrichten enthält, legen Sie ulTotal auf 1 fest.
Weitere Informationen dazu, wie und wann Statusobjekte aufgerufen werden, finden Sie unter Anzeigen einer Statusanzeige.
MFCMAPI-Referenz
Einen MFCMAP-Beispielcode finden Sie in der folgenden Tabelle.
| Datei | Funktion | Kommentar |
|---|---|---|
| MAPIProgress.cpp |
CMAPIProgress::P rogress |
MFCMAPI verwendet die IMAPIProgress::P rogress-Methode, um den MFCMAPI-status-Balken mit dem aktuellen Prozentsatz des Fortschritts zu aktualisieren, der aus uValue und den aktuellen Maximal- und Minimalwerten berechnet wird. |