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

Developer

API Reference

ISHELL_STARTAPPLETARGS()

Brew Release
Brew MP 1.0.2
See Also
Error Codes Events IShell ISHELL_CreateInstance, ISHELL_StartAppletEx, ISHELL_StartBackgroundApplet, ISHELL_BrowseFile, ISHELL_BrowseURL
Description
This method allows passing command line arguments to a Brew MP application when it is started. This method instructs the AEE to start the applet associated with the specified 32-bit class ID, passing it the arguments. If the requested class is supported and can be started, the AEE loads and starts the applet. Note that this call returns immediately to the caller before starting the applet. The applet is started asynchronously. Hence, if the applet class ID being specified is not found, this function will still return TRUE but the applet will not be started.
When the applet is started or when it is resumed, the display is cleared (if the AFLAG_POPUP flag is not set) and the ISHELL_HandleEvent() is sent the EVT_APP_START or EVT_APP_RESUME 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.
NOTE: ISHELL_StartApplet() is an asynchronous function. The new applet is not started until control is released to the system:
- ISHELL_StartApplet() causes the current applet to receive an EVT_APP_SUSPEND
event immediately before the new application is started.
- Start arguments are passed as a character string in the AEEAppStart block.
The application may also receive an EVT_APP_BROWSE_FILE or EVT_APP_BROWSE_URL if the arguments are non-NULL.
Applications that do not handle the EVT_APP_SUSPEND command will not receive the argument block upon subsequent EVT_APP_START notifications when the application is restarted as part of the resume process.
Params
pIShell
[]:
Pointer to the IShell object.
cls
[]:
32-bit applet class ID.
pszArgs
[]:
ASCIIZ string of arguments to the application.
Interface
  • ISHELL
Prototype
  • int ISHELL_StartAppletArgs;
    (
    IShell *pIShell,
    AEECLSID cls,
    const char * pszArgs
    );
    
Return
  • AEE_SUCCESS: If the applet was created and started. AEE_EALREADY: If another applet is already starting. AEE_EBADCLASS: If the Shell class supplied was invalid. AEE_ENOMEMORY: If Insufficient memory. AEE_ECLASSNOTSUPPORT: If Class specified is not supported. AEE_EEXPIRED: If Applet has expired. AEE_EITEMBUSY: If current top visible application will not release control. AEE_EFILENOEXISTS: If The applet has been disabled. AEE_EUNABLETOLOAD: If OEM or current applet won't allow loading this applet.
Side Effect
  • The top-visible application may change.
Comments
None