CImageSet:Remove

CImageSet:Remove

The Remove method removes a CImage from the CImageSet by matching the CImage object to set members.

Syntax

member = CImageSet:Remove( CImage )

CImage specifies the CImage to remove.
member is the set member that was removed.
On success, this method returns the removed member.
On failure, nil is returned.

Remarks

This method finds the member in the list by searching the CImageSet to match the CImage object by value. On success, the CImage argument and the returned member should be equal.

Removing the member decreases the list Count by 1 member.

Example

Suppose a CImageSet exists with name S and that it contains 10 CImage objects. The following script fragment removes from the list the CImage I:

Printf("Count=%d", S:Count() )	-- result: count=10
S:Remove( I )	-- remove the CImage I
Printf("Count=%d", S:Count() )	-- result: count=9