<List> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyType » List

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32AddAdds a <Type> derived object 'Obj' to the <List>. The <List> then owns the object and the object will be deleted when the <List> is deleted.
int32AddRefAdds a <Type> derived object 'Obj' to the <List> as a reference. The object is not owned by the <List> and will not be deleted when the <List> is deleted.
int32ClearClears the <List> and destroys any objects that are owned by the <List>. Does not destroy the <List> object.
int32CountIsReturns true if the count of objects resident in the <List> matches the specified count.
int32CountIsNotReturns true if the count of objects resident in the <List> does not match the specified count.
int32DelDeletes an object from the <List>. If the <List> owns the object, the underlying memory is released.
int32DelAtDeletes the object at the specified index. If the <List> owns the object, the object is destroyed and its memory is released.
int32DoesNotContainReturns true if the <List> does not contain a pointer to the indicated object. Please note that this test works whether or not the <List> owns the object or merely references the object.
int32FindReturns the index of the object, or -1 if the object is not resident in the <List>.
<Type>GetReturns a <Type> pointer to an object in the <List>, at the specified index.
int32GetCountReturns the count of objects in the <List>.
<Type>GetFirstReturns the first object in the <List>.
<Type>GetFirstOfTypeReturns a pointer to the first object of the specified type.
<Type>GetLastReturns a pointer to the last object in the <List>.
int32GetLastIndexReturns the <int32> value of the last index in the <List>. The last index is computed as Count - 1.
int32InTests if the object 'p_oObject' is contained in the <List>.
int32InsertInserts an object in the <List>. The <List> takes ownership of the object.
int32InsertRefInserts a pointer to the object into the <List>. The <List> does not take ownership of the object.
int32IsCountMultipleReturns true if the number of items resident in the <List> object is a multiple of the specified count.
int32IsEmptyReturns true if zero objects are resident in the <List>.
int32IsHeterogenousReturns true if the <List> contains pointers to objects of more than one type.
int32IsHomogenousReturns true if the <List> contains pointers to objects of a single type.
int32MaxIndexReturns the maximum index in the <List>, which is: the <List> object's count - 1.
int32MoveMoves the object at the source index to the destination index. The <List> is temporarily re-ordered, so subsequent move operations may require recomputation to ensure their index values are correct.
int32MoveToEndMoves a <List> member to the end of the <List>.
int32OwnsAdds a <Type> derived object 'Obj' to the <List>. The <List> then owns the object and the object will be deleted when the <List> is deleted.
int32RefersAdds a <Type> derived object 'Obj' to the <List> as a reference. The object is not owned by the <List> and will not be deleted when the <List> is deleted.
int32RemoveRemoves the object from the <List>, but does not destroy it. The object's memory is not released.
<Type>RemoveAtRemoves the object from the <List> at the specified index and returns a pointer to the object. If the <List> owned the object, ownership of the object is released, but the object's memory is not freed. The object can be manually deleted or ownership can be transferred.
<Type>RemoveFirstRemoves the first object from the <List> and returns a pointer to the object. If the <List> owned the object, ownership of the object is released, but the object's memory is not freed. The object can be manually deleted or ownership can be transferred.
int32RemoveLastRemoves the last object from the <List> and returns a pointer to the object. If the <List> owned the object, ownership of the object is released, but the object's memory is not freed. The object can be manually deleted or ownership can be transferred.
int32ReverseReverses the order of the <List>.
int32TransferMoves <List> members from this <List> to a destination <List>. Ownership semantics are maintained: if ListA owns ListMember0, then ListB will own ListMember0.