IMAPIFolder::EmptyFolder
S’applique à : Outlook 2013 | Outlook 2016
Supprime tous les messages et sous-dossiers d’un dossier sans supprimer le dossier lui-même.
HRESULT EmptyFolder(
ULONG_PTR ulUIParam,
LPMAPIPROGRESS lpProgress,
ULONG ulFlags
);
Paramètres
ulUIParam
[in] Handle de la fenêtre parente de l’indicateur de progression. Le paramètre ulUIParam est ignoré, sauf si l’indicateur FOLDER_DIALOG est défini dans le paramètre ulFlags .
lpProgress
[in] Pointeur vers un objet progress qui affiche un indicateur de progression. Si NULL est passé dans lpProgress, le fournisseur de magasin de messages affiche un indicateur de progression à l’aide de l’implémentation de l’objet de progression MAPI. Le paramètre lpProgress est ignoré, sauf si l’indicateur FOLDER_DIALOG est défini dans le paramètre ulFlags .
ulFlags
[in] Masque de bits d’indicateurs qui contrôle la façon dont le dossier est vidé. Les indicateurs suivants peuvent être définis :
DEL_ASSOCIATED
Supprime tous les sous-dossiers, y compris les sous-dossiers qui contiennent des messages avec le contenu associé. L’indicateur DEL_ASSOCIATED a une signification uniquement pour le dossier de niveau supérieur sur lequel l’appel agit.
DELETE_HARD_DELETE
Supprime définitivement tous les messages, y compris les messages supprimés de manière réversible.
FOLDER_DIALOG
Affiche un indicateur de progression pendant la poursuite de l’opération.
Valeur renvoyée
S_OK
Le dossier a été vidé.
MAPI_W_PARTIAL_COMPLETION
L’appel a réussi, mais le dossier n’a pas été complètement vidé. Lorsque cet avertissement est retourné, l’appel doit être géré comme ayant réussi. Pour tester cet avertissement, utilisez la macro HR_FAILED . Pour plus d’informations, consultez Utilisation de macros pour la gestion des erreurs.
Remarques
La méthode IMAPIFolder ::EmptyFolder supprime tout le contenu d’un dossier sans supprimer le dossier lui-même.
Pendant un appel EmptyFolder , les messages envoyés ne sont pas supprimés.
Le contenu associé à un dossier comprend des messages qui sont utilisés pour décrire des vues, des règles, des formulaires personnalisés et un stockage de solution personnalisé, et peut également inclure des définitions de formulaires.
Remarques pour les responsables de l’implémentation
N’appelez pas la méthode IMsgStore ::AbortSubmit pour les messages du dossier qui ont été envoyés. Les messages envoyés ne sont pas supprimés.
Remarques pour les appelants
Attendez-vous à ces valeurs de retour dans les conditions suivantes.
| Condition | Valeur renvoy�e |
|---|---|
| EmptyFolder a vidé le dossier. | S_OK |
| EmptyFolder n’a pas pu vider complètement le dossier. | MAPI_W_PARTIAL_COMPLETION |
| EmptyFolder n’a pas pu se terminer. | Toute valeur d’erreur |
Lorsque EmptyFolder ne peut pas se terminer, ne supposez pas qu’aucun travail n’a été effectué. EmptyFolder a peut-être pu supprimer une partie du contenu du dossier avant de rencontrer l’erreur.
Référence MFCMAPI
Pour voir un exemple de code MFCMAPI, consultez le tableau suivant.
| Fichier | Fonction | Commentaire |
|---|---|---|
| MsgStoreDlg.cpp |
CMsgStoreDlg ::OnEmptyFolder |
MFCMAPI utilise la méthode IMAPIFolder ::EmptyFolder pour supprimer le contenu du dossier spécifié. |