Deletes a screen group and its associated data structures.

Synopsis

Err DeleteScreenGroup (Item screenGroupItem)

Description

This call undoes what CreateScreenGroup() does. Before release 1.3, DeleteScreenGroup() was defined to DeleteItem(), which was insufficient.

DeleteScreenGroup() frees memory for bitmap items, if and only if, the memory was allocated by CreateScreenGroup(). Screen and VDL items associated with the screenGroupItem are deleted.

Arguments

screenGroupItem
The item number of a screenGroup structure.

Return Value

The call returns 0 if successful or an error code (a negative value) if an error occurs.

Caveats

If you get clever with VDLs and bitmaps, don't assume DeleteScreenGroup() is as clever as you are. Unwind all your modifications before calling DeleteScreenGroup().

Implementation

Convenience call implemented graphics.lib V21.

Associated Files

graphics.h, graphics.lib

See Also

CreateScreenGroup()