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

Developer

API Reference

IAPPLETCTL_CANSTART()

Brew Release
Brew MP 1.0.2
See Also
Basic error codes IAppletCtl IAppletCtl_Start() IAppletCtl_Stop() ISHELL_StartApplet()
Description
This method is used to determine if the specified applet can start, given the start information.
If the applet being started is the screen saver app (SSA_SSAVER flag is set) the top visible app will be sent EVT_APP_NO_CLOSE(EVT_BUSY) 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(EVT_BUSY).
Params
pIAppletCtl
[]:
[in] Pointer to the IAppletCtl Interface object.
cls
[]:
[in] class ID of an applet.
pBuff
[]:
[in] Valid pointer to a structure of type AppStartInfo.
pnSize
[]:
[in] Specifies the size of pBuff in bytes.
Interface
Prototype
  •     int IAppletCtl_CanStart
        (
        IAppletCtl *pIAppletCtl,
        AEECLSID cls,
        void *pBuff,
        int *pnSize
        );
    
Return
  • AEE_SUCCESS: if successful. AEE_EBADPARM: if bad parameters are passed in (pnSize is NULL or AppStartInfo.dwReason is invalid). AEE_EEXPIRED: if the applet has expired. AEE_EFILENOEXISTS: if The applet has been disabled. AEE_EUNSUPPORTED: if this operation is not supported. AEE_EUNABLETOLOAD: if the OEM or the current app won't allow loading this applet. AEE_EITEMBUSY: the current application won't allow app to start.
    Other errors from AEEError.h are possible - such as ENOMEMORY, EBADCLASS, or EFAILED - when there are errors gathering the information.
Side Effect
  • None.
Comments
None.