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

Developer

API Reference

ISHELL_STARTAPPLET()

Brew Release
Brew MP 1.0.2
See Also
Error Codes Events IShell ISHELL_CreateInstance ISHELL_StartAppletEx ISHELL_StartBackgroundApplet ISHELL_BrowseFile ISHELL_BrowseURL NMASK_SHELL_START_STATUS
Description
This function instructs the AEE shell to start the applet associated with the specified 32-bit ClassID. If the requested class is supported and can be started, the AEE Shell loads and starts the applet. This call returns immediately to the caller before starting the applet.
The applet is started asynchronously, so if the applet classID being specified is not found, the function returns TRUE but the applet is not started. Asynchronous applet start success or failure is notified to applications registered with IShell with NMASK_SHELL_START_STATUS mask. When the applet is started or when it is resumed, the display is cleared (if the AFLAG_POPUP flag is not set) and the IAPPLET_HandleEvent() is sent the EVT_APP_START or EVT_APP_RESUME event along with the AEEAppStart parameter block. If the AFLAG_POPUP flag is set, the display is not cleared, and no guarantees are made about the state of the device bitmap. If an applet is started by another applet, the currently active applet is suspended.
Please note the following:
- ISHELL_StartApplet is an asynchronous function. The new applet
will not be started until control is released to the system.
- ISHELL_StartApplet will cause the current applet to receive an EVT_APP_SUSPEND
event immediately before the new application is started.
- If the applet being started is the screen saver applet (SSA_SSAVER flag is set), the
top-visible applet 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 applet will NOT be sent EVT_APP_NO_CLOSE(EVT_BUSY).
Params
pIShell
[]:
Pointer to the IShell interface object.
cls
[]:
32-bit applet ClassID.
Interface
  • ISHELL
Prototype
  • int ISHELL_StartApplet(IShell * pIShell, AEECLSID cls);
    
Return
  • AEE_SUCCESS: If the applet was created and started. AEE_EBADCLASS: If the Shell class supplied is invalid. AEE_ENOMEMORY: If there is insufficient memory. AEE_ECLASSNOTSUPPORT: If the class specified is not supported. AEE_EFILENOEXISTS: If the applet has been disabled. AEE_EUNABLETOLOAD: If the OEM layer refused to load the applet. AEE_EITEMBUSY: If the current top-visible application will not release control. AEE_ENOTALLOWED: if the flag SSA_BACKGROUND is passed to start an applet that is already in the app-history AEE_STREAM_WOULDBLOCK: if the flag SSA_AFTER_VOICE_CALL is specified and thus application start is deferred because of ongoing voice call
Side Effect
  • None
Comments
None