ListGet

Retrieves a single element from a list, based on its position.

Use ListGet when you need to pull one specific value out of a list variable - for example, grabbing the first item, the last item, or an item at a known position - rather than looping through the entire list.

Parameters

Returns

The value stored at the specified position in the list.

Example

If a list variable named Colors contains:

1: Red
2: Green
3: Blue

Then:

ListGet(Colors, 1)  →  Red
ListGet(Colors, 3)  →  Blue

Things to keep in mind

• 1-based indexing: Unlike many programming languages that start counting at 0, ListGet treats the first element as position 1. This is a common source of off-by-one errors, so double-check your index value if results look shifted.
• Out-of-range positions: If you're not sure how many elements a list contains, use ListSize first to check the count before calling ListGet, so you avoid requesting a position that doesn't exist.

Related articles

• ListSize — get the number of elements in a list
• ListAdd — add an element to a list
• List Variables — general overview of working with lists