listGetAt

Gets a list element at a specified position.

listGetAt(list, position [, delimiters [, includeEmptyValues]]) → returns string

  1. CFDocs
  2. Functions
  3. List Functions
  4. listGetAt
  5. CF
  6. Lucee
  7. BD
  8. 0 Issue
  9. Edit
See Also:   listDeleteAt   listInsertAt   listSetAt

Argument Reference

list string
Required

position numeric
Required

delimiter string
Default: ,

includeEmptyValues boolean
Default: false

Examples
Sample code invoking the listGetAt function

Returns the 2nd element in the list

listGetAt("foo,bar,lorem,ipsum", 2)

Expected Result: bar

Returns the 3rd element in the list using a custom delimiter

listGetAt("foo,bar|lorem,ipsum|me|something", 3, "|")

Expected Result: me

Returns the 4th element in the list, treating the empty element as a value

listGetAt("foo,bar,,lorem,ipsum", 4, ",", true)

Expected Result: lorem

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub