IMAPIFolder::EmptyFolder
Gilt für: Outlook 2013 | Outlook 2016
Löscht alle Nachrichten und Unterordner aus einem Ordner, ohne den Ordner selbst zu löschen.
HRESULT EmptyFolder(
ULONG_PTR ulUIParam,
LPMAPIPROGRESS lpProgress,
ULONG ulFlags
);
Parameter
ulUIParam
[in] Ein Handle für das übergeordnete Fenster der Statusanzeige. Der ulUIParam-Parameter wird ignoriert, es sei denn, das FOLDER_DIALOG-Flag ist im ulFlags-Parameter festgelegt.
lpProgress
[in] Ein Zeiger auf ein Statusobjekt, das eine Statusanzeige anzeigt. Wenn NULL in lpProgress übergeben wird, zeigt der Nachrichtenspeicheranbieter mithilfe der MAPI-Statusobjektimplementierung eine Statusanzeige an. Der lpProgress-Parameter wird ignoriert, es sei denn, das FOLDER_DIALOG-Flag ist im ulFlags-Parameter festgelegt.
ulFlags
[in] Eine Bitmaske von Flags, die steuert, wie der Ordner geleert wird. Die folgenden Flags können festgelegt werden:
DEL_ASSOCIATED
Löscht alle Unterordner, einschließlich Unterordnern, die Nachrichten mit zugeordnetem Inhalt enthalten. Das DEL_ASSOCIATED-Flag hat nur für den Ordner auf oberster Ebene Bedeutung, auf den der Aufruf reagiert.
DELETE_HARD_DELETE
Entfernt dauerhaft alle Nachrichten, einschließlich vorläufig gelöschter Nachrichten.
FOLDER_DIALOG
Zeigt eine Statusanzeige an, während der Vorgang fortgesetzt wird.
Rückgabewert
S_OK
Der Ordner wurde erfolgreich geleert.
MAPI_W_PARTIAL_COMPLETION
Der Aufruf war erfolgreich, aber der Ordner wurde nicht vollständig geleert. Wenn diese Warnung zurückgegeben wird, sollte der Aufruf als erfolgreich behandelt werden. Verwenden Sie zum Testen auf diese Warnung das Makro HR_FAILED . Weitere Informationen finden Sie unter Verwenden von Makros für die Fehlerbehandlung.
Hinweise
Die IMAPIFolder::EmptyFolder-Methode löscht den gesamten Inhalt eines Ordners, ohne den Ordner selbst zu löschen.
Während eines EmptyFolder-Aufrufs werden gesendete Nachrichten nicht gelöscht.
Die zugeordneten Inhalte eines Ordners umfassen Nachrichten, die zum Beschreiben von Ansichten, Regeln, benutzerdefinierten Formularen und benutzerdefiniertem Lösungsspeicher verwendet werden, und können auch Formulardefinitionen enthalten.
Hinweise für Implementierer
Rufen Sie die IMsgStore::AbortSubmit-Methode nicht für Nachrichten im Ordner auf, die übermittelt wurden. Übermittelte Nachrichten werden nicht gelöscht.
Hinweise für Aufrufer
Erwarten Sie diese Rückgabewerte unter den folgenden Bedingungen.
| Bedingung | R�ckgabewert |
|---|---|
| EmptyFolder hat den Ordner erfolgreich geleert. | S_OK |
| EmptyFolder konnte den Ordner nicht vollständig leeren. | MAPI_W_PARTIAL_COMPLETION |
| EmptyFolder konnte nicht abgeschlossen werden. | Beliebiger Fehlerwert |
Wenn EmptyFolder nicht abgeschlossen werden kann, gehen Sie nicht davon aus, dass keine Arbeit ausgeführt wurde. EmptyFolder konnte möglicherweise einen Teil des Ordnerinhalts löschen, bevor der Fehler auftritt.
MFCMAPI-Referenz
Einen MFCMAP-Beispielcode finden Sie in der folgenden Tabelle.
| Datei | Funktion | Kommentar |
|---|---|---|
| MsgStoreDlg.cpp |
CMsgStoreDlg::OnEmptyFolder |
MFCMAPI verwendet die IMAPIFolder::EmptyFolder-Methode , um den Inhalt des angegebenen Ordners zu löschen. |