Removes the specified object from a list of objects.
Input Arguments
0 |
Collection Object Name Ref List |
Object Name List |
The list of objects to modify. |
1 |
Integer |
Object Index |
The index of the object to remove from the list. |
Return Arguments
None.
Returned Status
SUCCESS |
The object was successfully removed from the list. |
FAILURE |
The index was invalid. |
Remarks
Indices are zero based, so the first object in the list is at index 0. The list collapses to fill any remaining holes.