CImageSet:RemoveFirst

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

Syntax

CImage = CImageSet:RemoveFirst()

bullet.gif    On success, the removed CImage is returned.

bullet.gif    On failure, nil is returned.

Remarks

Removing a list member decreases the list length by 1 member. Removal does not delete the CImage or its associated image.

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

CImageSet class, RemoveAt, RemoveLast, CImage class


Mira Pro x64 Script User's Guide, Copyright Ⓒ 2023 Mirametrics, Inc. All Rights Reserved.