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

Developer

API Reference

IAPPLETCTL_START()

Brew Release
Brew MP 1.0.2
See Also
AEEEvent IAppletCtl IAppletCtl_Stop() ISHELL_StartApplet()
Description
This method is used to start the specified applet class.
If the applet being started is the screen saver app (if SSA_SSAVER flag is set) the top-visible applet will be sent the EVT_APP_NO_CLOSE Applet Event (or the EVT_BUSY AEE Shell Event). If the SSA_SSAVER flag of the applet being started is not set the top-visible app will NOT be sent EVT_APP_NO_CLOSE (or EVT_BUSY).
Params
pIAppletCtl
[]:
[in] Pointer to the IAppletCtl Interface object
cls
[]:
[in] class ID of the applet to start.
pBuff
[]:
[in] Valid pointer to a structure of type AppStartInfo.
pnSize
[]:
[in] Specifies the size of pBuff in bytes.
Interface
Prototype
  •     int IAppletCtl_Start
        (
        IAppletCtl *pIAppletCtl,
        AEECLSID cls,
        void *pBuff,
        int *pnSize
        );
    
Return
  • AEE_SUCCESS: If successful. AEE_EBADPARM: If bad parameters are passed in (i.e. pnSize is NULL). AEE_EEXPIRED: If Applet has expired. AEE_EPRIVLEVEL: The caller doesn't have privileges to perform this operation. AEE_EFILENOEXISTS: If The applet has been disabled. AEE_EUNABLETOLOAD: If the OEM or the current applet won't allow loading this applet. AEE_EUNSUPPORTED: If this operation is not supported. AEE_ENOTALLOWED: The OEM code won't allow application to start. AEE_EITEMBUSY: If current top visible application will not release control.
    Other errors from AEEError.h are possible, for example AEE_ENOMEMORY, AEE_EBADCLASS or AEE_EFAILED, when errors gathering the information occur.
Side Effect
  • The top-visible application will change.
Comments
None.