DeleteVDL

Deletes a VDL and all its associated data structures.

Synopsis

Err DeleteVDL (Item vdlItem)

Description

This macro is a convenience call to DeleteItem(). It deletes a VDL that was created with a call to SubmitVDL(). Any data structures and buffers allocated by SubmitVDL() are also deleted.

After the call to this macro, the VDL item number becomes invalid. If the VDL is currently being used in a screen that's being displayed, the screen will go black.

Arguments

vdlItem: The item number of a VDL structure.

Return Value

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

Implementation

Macro implemented in graphics.h V20.

Associated File

graphics.h

Caveats

DeleteScreenGroup() does not delete VDLs that were created with the initial CreateScreenGroup() if new VDLs have been attached to the screens with SetVDL(). If a new VDL has been attached to a screen in the ScreenGroup being deleted with the DeleteScreenGroup() call, then the new VDL is deleted as well.