dbDeleteObject

dbDeleteObject(
d_object
)
=> t / nil 

Description

Deletes one of the following objects: shapes, nets, terminals, instance terminals, pins, instance pins, mosaics, instances, mosaic instances, properties, groups, and group members. Any other object type produces an error.

If the object is a mosaic, the associated mosaic instance list and personality array are also deleted. If the object is a net, the net’s terminal is automatically deleted and the instance terminals are disconnected from the net. If the object is a terminal, all of the associated pins are automatically deleted and corresponding instance terminals and instance pins are unbound. If the object is a pin, the instance pins are unbound and the figure is detached from the pin but not deleted.

Other functions that delete database objects, documented elsewhere in this chapter, are dbDeletePropByName, dbDeleteObjectFromGroup and dbDeleteAllNet.

Arguments

d_object

The object to be deleted; can be shapes, nets, terminals, instance terminals, pins, instance pins, mosaics, instances, mosaic instances, properties, groups, and group members. Any other object type produces an error.

Value Returned

t	The object is deleted.
nil	The object is not deleted.

Examples

dbDeleteObject(net)

Related Topics

Data Stored as Objects

Return to top