CImageSet:RemoveFirst

The RemoveFirst method removes the CImage from the head of the list.

Syntax

CImageOld = CImageSet:RemoveFirst()

where

    CImageOld is the CImage object that was removed. If the CImage was not removed, nil is returned.

  

Removing the object decreases the set Count by 1 member. Removal does not delete the CImage.

Example

Suppose a CImageSet exists with name S and that it contains 10 images. The following script removes the member at the head of the list:

Printf("count=%d", S:Count() )

-- result: count=10

S:RemoveFirst()

-- remove the first member

Printf("count=%d", S:Count() )

-- result: count=9

Related Topics

RemoveAt

RemoveLast

CImageSet class

CImage class