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

Developer

API Reference

PIM_IMESSAGESTORE_GETSUBFOLDERIDS()

Brew Release
Brew MP 1.0.2
See Also
Error Codes pim_IMessageStore pim_IMessageStore_GetFolderInfo
Description
Get the list of identifiers for all the direct subfolder in the given folder.
Params
pif
[in]:
Pointer to pim_IMessageStore interface
nFolderID
[in]:
Folder ID to identify the folder.
pSubFolderIDs
[out]:
Array of pim_IMessageStore_MsgFolderID to store the subfolder IDs
nSubFolderIDsLen
[in]:
Number of elements in the array
pnSubFolderIDsLenReq
[out]:
Required minimum array elements to store all the subfolder IDs in the folder.
Interface
Prototype
  •    AEEResult pim_IMessageStore_GetSubFolderIDs(pim_IMessageStore* pif, 
                                                   pim_IMessageStore_MsgFolderID nFolderID,  
                                                   pim_IMessageStore_MsgFolderID* pSubFolderIDs,  
                                                   int nSubFolderIDsLen, 
                                                   int* pnSubFolderIDsLenReq);
    
Return
  • AEE_SUCCESS : successful. pim_IMessageStore_EINVALIDFOLDERID : invalid folder ID is passed in. AEE_EWOULDBLOCK : the message store is blocked from accessing folders. Other error code : indicating the nature of the failure.
Side Effect
  • None
Comments
None