Get i-th Object From Collection Object Name Ref List (Iterator)    

Returns the name of an object at a specified index in a collection object name reference list. This command is an iterator, which means it is a shortcut to a traditional loop. Iterators proceed sequentially, one-by-one, from a starting index, until the end of the list. For more information on iterators, see Iterators.

 

Input Arguments

 

0

Collection Object Name Ref List

Object Name List

The list of objects to consider.

1

Integer

Object Index

The starting index of the object to consider.

2

Step ID

Step to Jump at End of List

The step to jump to after iterating through the last object in the list.

 

Return Arguments

 

3

String

Collection

The collection containing the object at the speci- fied index.

4

String

Object

The name of the object at the specified index.

5

String

Object Type

The type of the object at the specified index.

6

Collection Object Name

Resultant Object

The object at the specified index, as a collection object name data type.

 

Returned Status

 

SUCCESS

The object name was determined successfully.

FAILURE

The index supplied was beyond the bounds of the list.

 

Remarks

Ref list indices are zero based, so the first object in a ref list is at index 0.