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

Developer

API Reference

PIM_IMESSAGESTORE_DELETEFOLDER()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IMessageStore pim_IMessageStore_AddFolder
Description
If user-defined folders are supported, this function deletes a folder from the store. Only empty, user-defined folders can be deleted.
Params
pif
[in]:
Pointer to pim_IMessageStore interface
nFolderID
[in]:
Folder ID identifying the folder to be deleted.
Interface
Prototype
  •    AEEResult pim_IMessageStore_DeleteFolder(pim_IMessageStore* pif, 
                                                pim_IMessageStore_MsgFolderID nFolderID); 
                                            
                                 
Return
  • AEE_SUCCESS : successful. AEE_EUNSUPPORTED : user-defined folders are not supported. pim_IMessageStore_EINVALIDFOLDERID : invalid folder ID is passed in. AEE_EWOULDBLOCK : the message store is blocked from deleting a folder. AEE_EPRIVLEVEL : the caller does not have the required privilege as specified in the implementation. AEE_ENOTALLOWED : the folder is not empty or the folder is protected with flag PROTECTED. Other error code : indicating the nature of the failure.
Side Effect
  • None
Comments
None