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

Developer

API Reference

ISETTINGS_RESET()

Brew Release
Brew MP 1.0.2
See Also
ISettings ISettings_OnChange() Error Codes
Description
This method restores the specified setting or settings subtree to its original state. Settings not included in the default settings set are removed, settings included in the default settings set are re-added if necessary, and all remaining settings are reset to their original values.
Params
_me
[]:
[in] A pointer to the ISettings object.
key
[]:
[in] A NULL-terminated string representing the setting to be reset.
Interface
Prototype
  •    int ISettings_Reset(ISettings *_me, 
                           const char *key);
    
Return
  • AEE_SUCCESS : On success. AEE_EBADITEM : The requested setting or settings subtree does not exist. AEE_EUNSUPPORTED : The operation isn't supported by the implementation. AEE_EPRIVLEVEL : The caller does not have sufficient privileges for this operation. Error code : Otherwise.
Side Effect
  • The specified setting or settings subtree is returned to its default state and value.
    If ISettings_OnChange() was called to register for change notifications on this setting or settings subtree, the provided signal will be set.
Comments
None