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

Developer

API Reference

ISHELL_GETAPPPREFS()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IShell ISHELL_SetAppPrefs
Description
This method provides a means for retrieving a structure containing applet preferences. Applications can use this as a means to store/retrieve application-specific settings or preferences information persistently. The information is stored in a file. Use ISHELL_SetAppPrefs() to store the preferences.
Params
pIShell
[]:
Pointer to the IShell object.
wVer
[]:
Version of the preference.
pCfg
[]:
Pointer to memory to fill with preference data.
nSize
[]:
Size of memory block to fill.
Interface
  • ISHELL
Prototype
  •     int ISHELL_GetAppPrefs
        (
        IShell * pIShell,
        uint16 wVer,
        void * pCfg,
        uint16 nSize
        );
    
Return
  • AEE_SUCCESS : if the operation succeeded.
    Non-zero size of the record : if pCfg == NULL or if nSize is insufficient.
Side Effect
  • None
Comments
None