company logo

PropertyHandle :: DeleteSet - Delete/remove all instance in a collection

The function removes all instances from the collection. Instances are removed/deleted as described in the Delete() function. When the function fails the collection remains unchanged.

Notes:

When a selection (filter) has been set for the collection, only instances fullfilling the filter condition will be deleted (SetFilter()).

Return value:  Success ( logical  )

Implementation details

logical PropertyHandle  :: DeleteSet ( logical del_dep=YES )
  • del_dep - Delete dependent instances

    Usually this option is set to YES, i.e. all dependent instances are deleted when being removed from the collection. Passing NO dependent instances are not deleted but removed from the collection, only.

    Instances owned by the collection, however, will be deleted always.

    When deleting a collection (DeleteSet()) with a filter condition, only instances that are filtered will be selected. In order to delete the complete collection, the option should be set to 2 (not deleting depending instances ) or 3 (delete all and depending instances).

    Default: YES