Get i-th Point Name From Point Name Ref List (Iterator)    

Returns the name of a point at a specified index in a point 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 Loop Structures in the Fundamental Terms Chapter.

 

Input Arguments

 

0

Point Name Ref List

Point Name List

The list of points to consider.

1

Integer

Point Name Index

The starting index of the point to consider.

2

Step ID

Step to Jump at End of List

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

 

Return Arguments

 

3

String

Collection

The collection containing the current point.

4

String

Group

The point group containing the current point.

5

String

Target

The point name of the current point.

6

Point Name

Resulting Point Name

The name of the current point as a Point Name data type.

7

Vector

Vector in Working

The coordinates of the returned point.

 

Returned Status

 

SUCCESS

The point 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 point in a ref list is at index 0.