CSet:Remove

The Remove method removes a member from the CSet by matching its value to a set member.

Syntax

member = CSet:Remove( value )

value specifies the member 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 list to match its value. On success, the value argument and the returned member should be equal.

Removing a set member decreases the list Count by 1 member.

Example

Suppose a CSet exists with name S and that it contains 10 strings. The following script fragment removes from the list the string "ABC""

Printf("count=%d", S:Count())	-- result: count=10
S:Remove( "ABC" )	-- remove the member at index 5
Printf("count=%d", S:Count())	-- result: count=9