api_del_entity_list
List of: Functions
Subjects: Model Topology
Contents: Kernel

Action: Deletes the given list of entities.

Prototype: outcome api_del_entity_list (


ENTITY_LIST& given_list, // entities to be deleted


AcisOptions* ao = NULL // acis options


);

Includes: #include "kernel/acis.hxx"

#include "kernel/kernapi/api/api.hxx"

#include "kernel/kernapi/api/kernapi.hxx"

#include "kernel/kerndata/lists/lists.hxx"

#include "kernel/kernapi/api/acis_options.hxx"

Description: This API deletes all the entities in an entity list and all their associated entities. This loses all entities that are connected to the given entities. It will lose multiple bodies if they are connected by attributes. It does not affect any pointers that were pointing to any of the objects. This allows deletion of an entire entity from anywhere in the entity's topological hierarchy without having to traverse to the top of the topology chain.


Use this API instead of api_del_entity when you need to delete more than one entity at a time, since calling api_del_entity repeatedly could be dangerous as the user has to keep track of what in the list has already been deleted.

Limitations: Deletes entities above as well as below the specified entities in the hierarchy.

Library: kernel

Filename: kern/kernel/kernapi/api/kernapi.hxx

Effect: Changes model
PDF/KERN/16FNA.PDF
HTM/DATA/KERN/KERN/16FNA/0035.HTM