CImageView:Remove

The Remove method removes a CImage from the CImageView and frees memory associated with the image.

Syntax

bSuccess = CImageView:Remove( nIndex )

where

nIndex is the index of the deletion point, in the range 1 to Count.

bSuccess is the returned success code. On success it is true, otherwise false.

The CImageView refers to a Mira image display window. The Image window uses an image set to display multiple images. This command removes the specified image from the image set and deletes the image from memory.

This method fails if you attempt to remove the only image or ifnIndex is out of bounds.

Example

Suppose a CImageView exists, is assigned toV, and its window contains more than 3 images. The following script removes the image at index 3:

bSuccess = V:Remove( 3 )	-- delete the image at index 3
if ( not bSuccess ) then
Printf("Cannot delete at %d", 3 )
end