ecl-logo Documentation

EraseFavoriteFolder

EraseFavoriteFolder[folders]Null

remove the favorite folder(s) and all the favorite objects within them.

Details

  • This is used in the Command Center to keep track of objects marked as favorites by user.
  • If folder is empty, it simply deletes it.
  • If folder contains favorite objects, it deletes them first and then deletes the folder.
  • This information will be used to display information in favorite dashboard.
  • Input

Examples

Basic Examples  (1)

Remove favorite folder and favorite objects within it, verify target object is not removed:

Additional Examples  (2)

Remove empty favorite folder:

Remove list of favorite folders and favorite objects within it: