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

Developer

API Reference

IAPPLETCTL_GETRUNNINGINFO()

Brew Release
Brew MP 1.0.2
See Also
AEEAppItem Error Codes IAppletCtl IAppletCtl_GetRunningList() ISHELL_EnumNextApplet()
Description
This method is used to get specific information about one of the currently running applications. This function takes an ID that specifies what information is needed. The buffer contains the corresponding information on return.
Params
pIAppletCtl
[]:
[in] Pointer to the IAppletCtl Interface object.
cls
[]:
[in] The class ID of a currently running applet.
nItem
[]:
[in] Specifies the Item whose info is needed. Please see documentation of AEEAppItem for the supported items.
pBuff
[]:
[in/out] Contains the corresponding information on return, may be NULL, if querying for size of the item.
pnSize
[]:
[in/out] On input, when pBuff is non-NULL, pnSize specifies the size of pBuff in bytes. On output, pnSize will be set to the number of bytes required to hold the DeviceInfoEx() item data.
Interface
Prototype
  •     int IAppletCtl_GetRunningInfo
        (
        IAppletCtl *pIAppletCtl,
        AEECLSID cls
        AEEAppItem nItem,
        void *pBuff,
        int *pnSize
        );
    
Return
  • AEE_SUCCESS: if successful. AEE_EBADCLASS: If specified cls is not a currently running applet. AEE_EBADPARM: if bad parameters are passed in (pnSize is NULL). AEE_EUNSUPPORTED: if this item is not supported.
    Other errors from AEEError.h are possible, for example AEE_ENOMEMORY or AEE_EFAILED, when errors gathering the information occur.
Side Effect
  • None.
Comments
This function may partially fill pBuff in the case where pnSize is not large enough to hold all item data. In this case, pnSize will be set to the size required.