arrayMid

Extracts a sub array from an existing array.

arrayMid(array, start [, count]) → returns array

Member Function Syntax

array.mid(start [, count])

This function requires Lucee.  Not supported on Adobe ColdFusion, etc.
  1. CFDocs
  2. Functions
  3. Array Functions
  4. arrayMid
  5. Lucee
  6. 0 Issue
  7. Edit
See Also:   arraySlice

Argument Reference

array array
Required

Array to extract data from

start numeric
Required

The position of the first element to retrieve

count numeric

The number of elements to extract. If not set, all elements up to the end of the array will be returned.

Examples
Sample code invoking the arrayMid function

Lucee 4.5+ Extract elements from an array staring with element 5 and ending with the last element of the array.

vehicles = ['Mustang','Nova','Celica','Camry','Tacoma','Tundra','Ram','F-250'];
trucks = arrayMid(vehicles, 5);
writeOutput(arrayToList(trucks));

Expected Result: Tacoma,Tundra,Ram,F-250

Lucee 4.5+ Extract 4 elements from an array staring with element 3.

vehicles = ['Mustang','Nova','Celica','Camry','Tacoma','Tundra','Ram','F-250'];
toyotas = arrayMid(vehicles, 3, 4);
writeOutput(arrayToList(toyotas));

Expected Result: Celica,Camry,Tacoma,Tundra

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

Fork me on GitHub