IMAPIStatus::FlushQueues
Gilt für: Outlook 2013 | Outlook 2016
Erzwingt, dass alle Nachrichten, die darauf warten, gesendet oder empfangen zu werden, sofort hochgeladen oder heruntergeladen werden. Der MAPI-Spooler status Objekt und status Objekte, die Transportanbieter implementieren, unterstützen diese Methode.
HRESULT FlushQueues(
ULONG_PTR ulUIParam,
ULONG cbTargetTransport,
LPENTRYID lpTargetTransport,
ULONG ulFlags
);
Parameter
ulUIParam
[in] Ein Handle für das übergeordnete Fenster aller Dialogfelder oder Fenster, die von dieser Methode angezeigt werden.
cbTargetTransport
[in] Die Byteanzahl im Eintragsbezeichner, auf die der lpTargetTransport-Parameter verweist. Der cbTargetTransport-Parameter wird nur bei Aufrufen des status-Objekts des MAPI-Spoolers festgelegt. Bei Aufrufen eines Transportanbieters wird der cbTargetTransport-Parameter auf 0 festgelegt.
lpTargetTransport
[in] Ein Zeiger auf den Eintragsbezeichner des Transportanbieters, der seine Nachrichtenwarteschlangen leeren soll. Der lpTargetTransport-Parameter wird nur bei Aufrufen des status-Objekts des MAPI-Spoolers festgelegt. Bei Aufrufen eines Transportanbieters wird der lpTargetTransport-Parameter auf NULL festgelegt.
ulFlags
[in] Eine Bitmaske von Flags, die den Leerungsvorgang steuert. Die folgenden Flags können festgelegt werden:
FLUSH_ASYNC_OK
Der Leerungsvorgang kann asynchron erfolgen. Dieses Flag gilt nur für das status-Objekt des MAPI-Spoolers.
FLUSH_DOWNLOAD
Die eingehenden Nachrichtenwarteschlangen sollten geleert werden.
FLUSH_FORCE
Der Leerungsvorgang sollte unabhängig von der Wahrscheinlichkeit einer Leistungsminderung erfolgen. Dieses Flag muss festgelegt werden, wenn ein asynchroner Transportanbieter als Ziel verwendet wird.
FLUSH_NO_UI
Das status-Objekt sollte keine Statusanzeige anzeigen.
FLUSH_UPLOAD
Die Warteschlangen für ausgehende Nachrichten sollten geleert werden.
Rückgabewert
S_OK
Der Leerungsvorgang war erfolgreich.
MAPI_E_BUSY
Ein weiterer Vorgang wird ausgeführt. Der Vorgang sollte abgeschlossen oder beendet werden, bevor dieser Vorgang initiiert werden kann.
MAPI_E_NO_SUPPORT
Das status-Objekt unterstützt diesen Vorgang nicht, wie das Fehlen des STATUS_FLUSH_QUEUES-Flags in der PR_RESOURCE_METHODS-Eigenschaft (PidTagResourceMethods) des status-Objekts anzeigt.
Hinweise
Die IMAPIStatus::FlushQueues-Methode fordert an, dass der MAPI-Spooler oder ein Transportanbieter sofort alle Nachrichten in der ausgehenden Warteschlange sendet oder alle Nachrichten aus der eingehenden Warteschlange empfängt. FlushQueues wird nur vom MAPI-Spooler status -Objekt und von status Objekten implementiert, die Transportanbieter bereitstellen.
MAPI_E_BUSY sollte für asynchrone Anforderungen zurückgegeben werden, damit Clients weiterhin arbeiten können.
Standardmäßig ist FlushQueues ein synchroner Vorgang. das -Steuerelement wird erst zum Aufrufer zurückgegeben, wenn die Leerung abgeschlossen ist. Nur der vom MAPI-Spooler ausgeführte Leerungsvorgang kann asynchron sein. -Clients fordern dieses Verhalten an, indem sie das flag FLUSH_ASYNC_OK festlegen.
Hinweise für Implementierer
Die Implementierung von FlushQueues eines Remotetransportanbieters legt Bits in der eigenschaft PR_STATUS_CODE (PidTagStatusCode) in der status Zeile des Anmeldeobjekts fest, um zu steuern, wie Warteschlangen geleert werden. Wenn ein Remote-Viewer das FLUSH_UPLOAD-Flag übergibt, sollte die FlushQueues-Methode die STATUS_INBOUND_ENABLED und STATUS_INBOUND_ACTIVE Bits festlegen. Wenn ein Remote-Viewer das FLUSH_DOWNLOAD-Flag übergibt, sollte die FlushQueues-Methode die STATUS_OUTBOUND_ENABLED und STATUS_OUTBOUND_ACTIVE Bits festlegen. FlushQueues sollte dann S_OK zurückgeben. Der MAPI-Spooler initiiert dann die entsprechenden Aktionen zum Hochladen und Herunterladen von Nachrichten.
Hinweise für Aufrufer
Ein Aufruf des MAPI-Spoolers status -Objekts ist eine Direktive, um alle Nachrichten entweder an oder vom entsprechenden Transportanbieter zu übertragen. Wenn Sie das status -Objekt eines einzelnen Transportanbieters aufrufen, sind nur die Nachrichten für diesen Anbieter betroffen.
Siehe auch
PidTagResourceMethods (kanonische Eigenschaft)