Returns the name of a relationship at a specified index in a relationship 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.
Input Arguments
0 |
Relationship Ref List |
Reference List |
The list of relationships to consider. |
1 |
Integer |
Relationship Index |
The starting index of the relationship to consider. |
2 |
Step ID |
Step to Jump at End of List |
The step to jump to after iterating through the last relationship in the list. |
Return Arguments
3 |
String |
Collection |
The collection containing the relationship at the specified index. |
4 |
String |
Relationship |
The name of the relationship at the specified index. |
5 |
Collection Object Name |
Resultant Item |
The relationship at the specified index, as a collec- tion object name data type. |
Returned Status
SUCCESS |
The relationship 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 item in a ref list is at index 0.