API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

PIM_IMESSAGESTORE_DELETEMSG()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IMessageStore pim_IMessageStore_AddMsg
Description
Delete a specified messages from the store. If the message is protected with flag PROTECTED, the message can't be deleted. Application need to remove this flag first because it can be deleted.
Params
pif
[in]:
Pointer to pim_IMessageStore interface
nMsgID
[in]:
Message ID identifying the meesage to be deleted.
Interface
Prototype
  •    AEEResult pim_IMessageStore_DeleteMsg(pim_IMessageStore* pif, 
                                             pim_IMessageStore_MessageID nMsgID);
                                 
    
Return
  • AEE_SUCCESS : successful. pim_IMessageStore_EINVALIDMSGID : an invalid message ID is passed in. AEE_EWOULDBLOCK : the message store is blocked from deleting a message. AEE_EPRIVLEVEL : the caller does not have the required privilege as specified in the implementation. AEE_ENOTALLOWED : the specified message is protected with flag PROTECTED. Other error code : indicating the nature of the failure.
Side Effect
  • None
Comments
None