Lucee object methods reference

Object Method String.listToArray

Copies the elements of a list to an array.
String.listToArray([string delimiter,[boolean includeEmptyFields,[boolean multiCharacterDelimiter]]]):array

Category

list,string,array

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Default Value Description
delimiter string  No , Characters that separate list elements. The default value is comma.
includeEmptyFields boolean  No   if set to true, empty values are included as well
multiCharacterDelimiter boolean  No false specifying whether the delimiters parameter specifies a multi-character delimiter. The default is false. If this parameter is true, the delimiters parameter must specify a single delimiter consisting of multiple characters. This parameter enables the ListToArray function to convert a list such as the following to an array of color names: red:|orange:|yellow:|green:|blue:|indigo:|violet.