ObjectCollection.removeByIndex Method

Parent Object: ObjectCollection
Defined in namespace "adsk::core" and the header file is <Core/Application/ObjectCollection.h>

Description

Function that removes an item from the list. Will fail if the list is read only.

Syntax

"objectCollection_var" is a variable referencing an ObjectCollection object.
returnValue = objectCollection_var.removeByIndex(index)
"objectCollection_var" is a variable referencing an ObjectCollection object.

#include <Core/Application/ObjectCollection.h>

returnValue = objectCollection_var->removeByIndex(index);

Return Value

Type Description
boolean Returns true if the removal was successful.

Parameters

Name Type Description
index uinteger The index of the item to remove from the collection. The first item has an index of 0.

Version

Introduced in version August 2014