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

Developer

API Reference

ISHELL_SETPREFS()

Brew Release
Brew MP 1.0.2
See Also
Error Codes IShell ISHELL_GetPrefs
Description
This function provides a method for storing a structure containing applet or class-level preferences. The default behavior of ISHELL_SetPrefs is that the prefs data is written to an in-memory cache, which gets written out to the file system in the near future, but asynchronously. If it is desired that the preference be written out to file system synchronously with the call to ISHELL_SetPrefs, set the most significant bit of the nSize input parameter to 1.
Params
pIShell
[]:
Pointer to the IShell interface object.
cls
[]:
AEECLSID of the preference type.
wVer
[]:
Version of the preference.
pCfg
[]:
Pointer to the preference data to be stored.
nSize
[]:
Size of the memory block to store.
Interface
  • ISHELL
Prototype
  •     int ISHELL_SetPrefs
        (
        IShell * pIShell,
        AEECLSID cls,
        uint16 wVer,
        void * pCfg,
        uint16 nSize
        );
    
Return
  • AEE_SUCCESS: The operation was successful. AEE_EBADPARM: Invalid parameter. AEE_ENOMEMORY: Insufficient memory. AEE_EFAILED: The operation failed.
Side Effect
  • None
Comments
Using different version(wVer) for the same classID would over write the previous record, if there is any.