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

Developer

API Reference

IAPPLETCTL_TERMINATE()

Brew Release
Brew MP 1.0.2
See Also
AEEEvent AEE Privilege Levels IAppletCtl IAppletCtl_Start() IAppletCtl_Stop()
Description
This method is used to stop a currently running applet. It requires the PL_SYSTEM privilege unless the cls parameter == the caller's class. The applet will receive an EVT_APP_STOP Applet Event regardless of the number of entries this app has on the history list. If the applet refuses to close on the EVT_APP_STOP event, the applet receives the EVT_APP_TERMINATE event and is forcefully closed. None of the history entries for the applet will be removed. The only exception to this rule is if the applet is currently the top-visible entry; in such a case, the top-visible history entry will be removed. If the applet being closed is currently top-visible, the next applet in the history list will be resumed or started.
Params
pIAppletCtl
[]:
[in] a pointer to the IAppletCtl Interface object.
cls
[]:
[in] the class ID of a currently running applet.
Interface
Prototype
  •     int IAppletCtl_Terminate
        (
        IAppletCtl *pIAppletCtl,
        AEECLSID cls
        );
    
Return
  • AEE_SUCCESS: if successful. AEE_EBADCLASS: If the class ID specified by cls is not an existing applet, or is an applet that is not loaded. AEE_EPRIVLEVEL: the caller doesn't have privileges to perform this operation.
Side Effect
  • The top-visibile application may change.
Comments
None.