Delete_Segment

Functions

void Delete_Segment (const char *segment)
 Throws away a segment when you no longer need it. Can also be used to shut down a display. More...
 

Detailed Description

Function Documentation

◆ Delete_Segment()

void Delete_Segment ( const char *  segment)

Throws away a segment when you no longer need it. Can also be used to shut down a display.

Parameters
segment- Name of the segment(s) to be deleted. Can include wild cards.

DETAILS

Deletes a previously created segment and all its subsegments from the segment tree. Nothing that's to be deleted can be open. Segments referenced indirectly by the deleted segment (Styles and Includes) are not affected.

Closely related routines include Reset_System() , which quickly deletes the entire tree plus all color definitions, alias definitions, etc., Delete_By_Key() , which lets you select individual picture elements for removal; and Flush_Contents() , which deletes some or all of the contents of the segment but leaves the segment intact.

NOTE
If a segment being deleted is a "driver" segment—"?Picture", or something you've explicitly given a Driver attribute—the action routine will be called to shut down the device.

NOTES

RESTRICTIONS

See also
Rename_Segment, Flush_Contents, Delete_By_Key, Reset_System, Set_Driver, Open_Segment, Close_Segment.