CArray:Remove

The Remove method removes the CArray member at index n.

Syntax

value = CArray:Remove( nIndex )

where

    nIndex is the index of the member to be removed. On failure, nil is returned.

  

The return value corresponds to whatever type was saved into the CArray at the specified index. This may be a number, string, or other quantity.

Example

The following script removes the member at index nIndex = 10:

A = CArray:new()

-- create a CArray object

A:Set( 2, "s1" )

-- set member [2]

A:Set( 10, "s2" )

-- set member [10]

A:Set( 100, "s3" )

-- set member [100]

Printf("N = %d", A:Count() )

-- result: N = 3

v = A:Remove( 10 )

-- remove member [10]

Printf("N = %d, v='%s'", A:Count(), v )

-- result: N = 2, v='s2'

Related Topics

Count

CArray class