IMAPIFolder::DeleteMessages

Article
08/28/2006

The DeleteMessages method deletes one or more messages from the current folder.

Syntax

HRESULT DeleteMessages (
  LPENTRYLIST lpMsgList,
  ULONG ulUIParam,
  LPMAPIPROGRESS lpProgress,
  ULONG ulFlags
);

Parameters

lpMsgList
[in] Reference to an ENTRYLIST structure that contains the number of messages to delete and an array of ENTRYID structures identifying the messages; cannot be NULL.
ulUIParam
[in] Ignored.
lpProgress
[in] Ignored.
ulFlags
[in] Ignored.

Return Values

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

S_OK
Indicates success.
MAPI_W_PARTIAL_COMPLETION
The call succeeded, but not all of the messages were successfully deleted. When this warning is returned, the call should be handled as successful.

Remarks

Messages that do not exist, that have been moved elsewhere, that are open with read/write access, or that are currently submitted cannot be deleted.

When DeleteMessages is unable to complete, do not assume that no work was done. DeleteMessages might have been able to delete one or more of the messages before encountering the error.

Requirements

Pocket PC: Pocket PC 2002 and later
Smartphone: Smartphone 2002 and later
OS Versions: Windows CE 3.0 and later
Header: mapidefs.h
Library: cemapi.lib