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

Developer

API Reference

PIM_IMESSAGESTORE_UPDATEMSG()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IMessageStore
Description
Update a message in the store. Note that OTA message part and the attribute string can be updated separately because neither part can be empty for a valid message. Therefore, if nNewMsgLen = 0, only the message attributes will be updated. On the other hand, if pNewMsgAttrStr is an empty string, only the OTA message part will be updated.
Params
pif
[in]:
Pointer to pim_IMessageStore interface
nMsgID
[in]:
Message ID to identify the message to be updated.
pNewMsg
[in]:
Pointer to the message buffer storing the new OTA message.
nNewMsgLen
[in]:
The lenght of the message buffer in byte.
pNewMsgAttrStr
[in]:
New attribute stirng.
Interface
Prototype
  •    AEEResult pim_IMessageStore_UpdateMsg(pim_IMessageStore* pif, 
                                             pim_IMessageStore_MessageID nMsgID,
                                             const unsigned char* pNewMsg, 
                                             int nNewMsgLen,
                                             const char* pNewMsgAttrStr);
    
Return
  • AEE_SUCCESS : successful. pim_IMessageStore_EINVALIDMSGID : invalid message ID is passed in. AEE_EWOULDBLOCK : the message store is blocked from updating a message. AEE_EPRIVLEVEL : the caller does not have the required privilege as specified in the implementation. Other error code : indicating the nature of the failure.
Side Effect
  • None
Comments
None