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

Developer

API Reference

IITEMSTORE_SET()

Brew Release
Brew MP 1.0.2
See Also
IItemStore_Get IItemStore_OnChange
Description
This method sets the value of the item to the specified string.
Params
po
[]:
[in] Pointer to IItemStore interface
pszItem
[]:
[in] Item Value
Interface
Prototype
  •    int IItemStore_Set(IItemStore * po, const char *pszItem)
    
Return
  • AEE_SUCCESS: if the data is copied. AEE_ENOSUCH: if the value of the item is not known. AEE_EREADONLY: can get item string, but not set it. AEE_ENOMEMORY: can't allocate heap memory to store item. AEE_EUNSUPPORTED: if Set is not supported for this object.
    Other return values indicating an error, depending on the implementation or item.
Side Effect
  • None
Comments
The standard behavior is to copy the data pointed to by pItem. The caller can assume the data has been copied and doesn't have to manage the lifetime of the data any further. Exceptions to this rule are allowed if clearly documented. If the object is not a settable item, this function returns the error status AEE_EUNSUPPORTED.