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

Developer

API Reference

PIM_IMESSAGESTORE_GETFOLDERINFO()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IMessageStore
Description
Get the folder information stored in the folder attribute string. The returned string preserves the original name-value pairs order when the folder was added.
Params
pif
[in]:
Pointer to pim_IMessageStore interface
nFolderID
[in]:
Folder ID to identify the folder.
pFolderAttrStr
[out]:
Pointer to a buffer used to store the requested folder attribute string.
nFolderAttrStrLen
[in]:
The size of the buffer.
nFolderAttrStrLenReq
[out]:
The required size to store the entire folder attribute string.
Interface
Prototype
  •    AEEResult pim_IMessageStore_GetFolderInfo(pim_IMessageStore* pif, 
                                                 pim_IMessageStore_MsgFolderID nFolderID,
                                                 char* pFolderAttrStr, 
                                                 int nFolderAttrStrLen, 
                                                 int* nFolderAttrStrLenReq);
                    
    
Return
  • AEE_SUCCESS : successful. pim_IMessageStore_EINVALIDFOLDERID : invalid folder ID is passed in. AEE_EWOULDBLOCK : the message store is blocked from reading a folder. Other error code : indicating the nature of the failure.
Side Effect
  • None
Comments
None