IMAPIProgress::GetFlags

Gilt für: Outlook 2013 | Outlook 2016

Gibt Flageinstellungen aus dem Statusobjekt für die Vorgangsebene zurück, auf der Statusinformationen berechnet werden.

HRESULT GetFlags(
  ULONG FAR * lpulFlags
);

Parameter

lpulFlags

[out] Eine Bitmaske von Flags, die die Vorgangsebene steuert, auf der Statusinformationen berechnet werden. Das folgende Flag kann zurückgegeben werden:

MAPI_TOP_LEVEL

Der Fortschritt wird für das Objekt der obersten Ebene berechnet, das Objekt, das vom Client aufgerufen wird, um den Vorgang zu starten. Das Objekt der obersten Ebene in einem Ordnerkopiervorgang ist beispielsweise der Ordner, der kopiert wird. Wenn MAPI_TOP_LEVEL nicht festgelegt ist, wird der Fortschritt für ein Objekt oder Unterobjekt auf niedrigerer Ebene berechnet. Beim Ordnerkopiervorgang ist ein Objekt auf niedrigerer Ebene einer der Unterordner in dem Ordner, der kopiert wird.

Rückgabewert

S_OK

Der Flags-Wert wurde erfolgreich zurückgegeben.

Hinweise

MapI ermöglicht es Dienstanbietern, zwischen Objekten der obersten Ebene und Unterobjekten mit dem flag MAPI_TOP_LEVEL zu unterscheiden, sodass alle an einem Vorgang beteiligten Objekte dieselbe IMAPIProgress-Implementierung verwenden können, um den Fortschritt anzuzeigen. Dies bewirkt, dass die Anzeige des Indikators reibungslos in einer einzigen positiven Richtung verläuft. Ob das MAPI_TOP_LEVEL-Flag festgelegt ist, bestimmt, wie Dienstanbieter die anderen Parameter in nachfolgenden Aufrufen des Statusobjekts festlegen.

Der von GetFlags zurückgegebene Wert wird zunächst vom Implementierer und anschließend vom Dienstanbieter durch einen Aufruf der IMAPIProgress::SetLimits-Methode festgelegt.

Hinweise für Implementierer

Initialisieren Sie das Flag immer auf MAPI_TOP_LEVEL, und verlassen Sie sich dann auf Dienstanbieter, um es ggf. zu löschen. Dienstanbieter können das Flag löschen und zurücksetzen, indem sie die IMAPIProgress::SetLimits-Methode aufrufen. Weitere Informationen zum Implementieren von GetFlags und den anderen IMAPIProgress-Methoden finden Sie unter Implementieren eines Statusindikators.

Hinweise für Aufrufer

Wenn Sie eine Statusanzeige anzeigen, führen Sie beim ersten Aufruf einen Aufruf von IMAPIProgress::GetFlags durch. Der zurückgegebene Wert sollte MAPI_TOP_LEVEL werden, da alle Implementierungen den Inhalt des lpulFlags-Parameters auf diesen Wert initialisieren. Weitere Informationen zur Reihenfolge der Aufrufe eines Statusobjekts finden Sie unter Anzeigen eines Statusindikators.

MFCMAPI-Referenz

Einen MFCMAP-Beispielcode finden Sie in der folgenden Tabelle.

Datei	Funktion	Kommentar
MAPIProgress.cpp	CMAPIProgress::GetFlags	MFCMAPI verwendet die IMAPIProgress::GetFlags-Methode , um zu bestimmen, welche Flags festgelegt sind. Gibt MAPI_TOP_LEVEL zurück, es sei denn, Flags wurden mithilfe der IMAPIProgress::SetLimits-Methode festgelegt.

Siehe auch

IMAPIProgress::SetLimits
IMAPIProgress : IUnknownMFCMAPI als Codebeispiel
Anzeigen einer Statusanzeige
Implementieren eines Statusindikators