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

Developer

API Reference

ISHELL_CLOSEAPPLET()

Brew Release
Brew MP 1.0.2
See Also
Error Codes Events IShell ISHELL_StartApplet, ISHELL_CanStartApplet, ISHELL_ActiveApplet Privileges
Description
This function instructs the AEE shell to close the active applet. The applet is sent the EVT_APP_STOP message and IAPPLET_Release() is called. Note that if ISHELL_StartApplet is called on an app which is about to close, EVT_APP_STOP will not be sent to that app. The bReturnToIdle parameter indicates whether the AEE must close all other active applications and return the idle screen.
Params
pIShell
[]:
Pointer to the IShell interface object.
bReturnToIdle
[]:
This parameter indicates whether Brew MP must close all active applications and return to the idle screen. If FALSE, only the currently running applet is closed. If TRUE, all applications having a history entry are closed. (Background applications don't have history entries.) PL_SYSTEM is required to call this function with bReturnToIdle set to TRUE.
Interface
  • ISHELL
Prototype
  • int ISHELL_CloseApplet(IShell * pIShell, boolean bReturnToIdle);
    
Return
  • AEE_SUCCESS: The operation was successful. AEE_EFAILED: The operation failed. AEE_EPRIVLEVEL: The caller does not have sufficient privilege level to call with bReturnToIdle set to TRUE.
Comments
None.