IMAPIFolder::DeleteFolder
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
Deletes a subfolder.
HRESULT DeleteFolder(
ULONG_PTR cbEntryID,
LPENTRYID lpEntryID,
ULONG_PTR ulUIParam,
LPMAPIPROGRESS lpProgress,
ULONG ulFlags
);
Parameters
cbEntryID
[in] The byte count in the entry identifier pointed to by the lpEntryID parameter.lpEntryID
[in] A pointer to the entry identifier of the subfolder to delete.ulUIParam
[in] A handle to the parent window of the progress indicator. The ulUIParam parameter is ignored unless the FOLDER_DIALOG flag is set in the ulFlags parameter.lpProgress
[in] A pointer to a progress object that displays a progress indicator. If NULL is passed in lpProgress, the message store provider displays a progress indicator by using the MAPI progress object implementation. The lpProgress parameter is ignored unless the FOLDER_DIALOG flag is set in ulFlags.ulFlags
[in] A bitmask of flags that controls the deletion of the subfolder. The following flags can be set:DEL_FOLDERS
All subfolders of the subfolder pointed to by lpEntryID should be deleted.DEL_MESSAGES
All messages in the subfolder pointed to by lpEntryID should be deleted.FOLDER_DIALOG
A progress indicator should be displayed while the operation proceeds.
Return Value
S_OK
The specified folder has been successfully deleted.MAPI_E_HAS_FOLDERS
The subfolder being deleted contains subfolders, and the DEL_FOLDERS flag was not set. The subfolders were not deleted.MAPI_E_HAS_MESSAGES
The subfolder being deleted contains messages, and the DEL_MESSAGES flag was not set. The subfolder was not deleted.MAPI_W_PARTIAL_COMPLETION
The call succeeded, but not all of the entries were successfully deleted. When this warning is returned, the call should be handled as successful. To test for this warning, use the HR_FAILED macro. For more information, see Using Macros for Error Handling.
Remarks
The IMAPIFolder::DeleteFolder method deletes a subfolder. By default, DeleteFolder operates only on empty folders, but you can use it successfully on non-empty folders by setting two flags: DEL_FOLDERS and DEL_MESSAGES. Only empty folders or folders that set both the DEL_FOLDERS and DEL_MESSAGES flags on the DeleteFolder call can be deleted. DEL_FOLDERS enables all of the folder's subfolders to be removed; DEL_MESSAGES enables all of the folder's messages to be removed.
Notes to Implementers
When the delete operation involves more than one folder, perform the operation as completely as possible for each folder. Sometimes one of the folders to be deleted does not exist or has been moved or copied elsewhere. Do not stop the operation prematurely unless a failure occurs that is beyond your control, such as running out of memory, running out of disk space, or corruption in the message store.
Notes to Callers
Expect these return values under the following conditions.
Condition |
Return value |
|---|---|
DeleteFolder has successfully deleted every message and subfolder. |
S_OK |
DeleteFolder was unable to successfully delete every message and subfolder. |
MAPI_W_PARTIAL_COMPLETION or MAPI_E_NOT_FOUND |
DeleteFolder was unable to complete. |
Any error value except MAPI_E_NOT_FOUND |
When DeleteFolder is unable to complete, do not assume that no work was done. DeleteFolder might have been able to delete one or more of the messages and subfolders before encountering the error.
If one or more subfolders cannot be deleted, DeleteFolder returns MAPI_W_PARTIAL_COMPLETION or MAPI_E_NOT_FOUND, depending on the message store provider's implementation.
MFCMAPI Reference
For MFCMAPI sample code, see the following table.
File |
Function |
Comment |
|---|---|---|
MsgStoreDlg.cpp |
CMsgStoreDlg::OnDeleteSelectedItem |
MFCMAPI uses the IMAPIFolder::DeleteFolder method to delete folders. |