| BOOL DeleteMessage( |
| |
LONG nMessageId |
|
| ); |
The DeleteMessage method removes the specified message from
the current message store.
Parameters
- nMessageId
- An integer value which identifies the message that is to be
removed from the message store. Message numbers begin at one and
increment for each message in the store.
Return Value
If the method succeeds, the return value is non-zero. If the
method fails, the return value is zero. To get extended error
information, call GetLastError.
Remarks
The DeleteMessage method marks the specified message for
deletion from the storage file. When the message store is closed or
purged, the message is removed from the file. Once a message has been
marked for deletion, it may no longer be referenced by the
application. For example, you cannot access the contents of a message
that has been deleted.
The message store must be opened with write access. This method
will fail if you attempt to delete a message from a storage file that
has been opened for read-only access. If the application needs to
delete messages in the message store, it is recommended that the file
be opened for exclusive access using the MIME_STORAGE_LOCK
option.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csmsgv10.lib
See Also
CloseFile,
FindMessage,
GetMessage,
GetMessageCount,
PurgeFile
|