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

Developer

API Reference

IAPPHISTORY_REMOVE()

Brew Release
Brew MP 1.0.2
See Also
IAppHistory_Top()
Description
This function removes the current entry from the app history list. IModel interface supported by IAppHistory notifies registered listeners about the removal.
Params
po
[]:
[in] Pointer to the IAppHistory Interface object.
Interface
Prototype
  •     int  IAppHistory_Remove(IAppHistory * po);
    
Return
  • AEE_SUCCESS - Item removed
    AEE_EPRIVLEVEL - Incorrect privilege level for this operation
    AEE_EFAILED - if this IAppHistory does not point to a history entry
    AEE_EALREADY - Item already being removed
Side Effect
  • Calling IAppHistory_Remove() on the last entry associated with a loaded applet will close the underlying applet. In this case, if the applet that needs to be closed is currently running, it will be closed asycnrhonously i.e. calling IAppHistory_Remove() will not result in synchronously sending EVT_APP_STOP to the app if the app is currently running. That will be done asynchronously.
    Calling IAppHistory_Remove() on the top-visible applet will cause the app associated with the next history entry to be resumed
    IAppHistory_Remove() will cause IAppHistory_Back() and IAppHistory_Forward() to fail with AEE_EINVALIDITEM on this and any other instance of IAppHistory that points to the removed entry. To restore an instance of IAppHistory to point into the history list, call IAppHistory_Top().
Comments
None