txDeleteFigSet

txDeleteFigSet(
T_figSet
[ g_deep = nil ]
)
=> t / nil

Description

Deletes the specified FigSet. If the optional argument g_deep is set to true, then the FigSets referenced by the specified FigSet will also be recursively deleted.

Arguments

T_figSet	ID of the FigSet.
g_deep	A flag that determines whether the FigSets referenced by the specified FigSet should be deleted.

Value Returned

t	The specified FigSet was deleted successfully.
nil	Returned in case of failure.

Examples

Deletes the FigSet fs1 and the FigSet referenced by it, fs0, from the cellview cv.

fs0 = txCreateFigSet(cv "fs0")

> tx@0x19d35cf0

fs1 = txCreateFigSet(cv "fs1")

> tx@0x19a46350

txAppendObjectToFigSet(fs1 fs0)

> t

txDeleteFigSet(fs1 t)

> t

txFindFigSet(cv "fs0")

> nil

txFindFigSet(cv "fs1")

> nil

Related Topics

FigSet Functions

Return to top