Developer

API Reference

IPERSISTENTSTORAGE_DeleteCategory()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
Error Codes IPERSISTENTSTORAGE_SetCategory IPERSISTENTSTORAGE_Exists
Description

Deletes the named category from the persistent store, along with any key/value pairs contained therein.
Parameters
  • storage
    []:
    Pointer to the IPersistentStorage interface object.
  • categoryName
    []:
    The name of the category to delete.
Interface
IPERSISTENTSTORAGE
Prototype
   int IPERSISTENTSTORAGE_DeleteCategory(IPersistentStorage* storage,
                                         const AECHAR* categoryName);
Return
AEE_SUCCESS: The category name was succesfully deleted. AEE_EFAILED: The category name does not exist or another error occurred.
Side Effect

If the currently set category is named for deletion, the category is unset after deletion succeeds. If deletion fails, the category is considered to be still set.
Comment
None
  • Follow