ListPrepend()
Inserts an element at the beginning of a list.
ListPrepend( list=string, value=string, delimiters=string, includeEmptyFields=boolean );
Returns: String
| Argument | Description | Default |
|---|---|---|
|
list
string,
required
|
edit
a string list |
|
|
value
string,
required
|
edit
An element or a list of elements. |
|
|
delimiters
string,
optional
|
edit
Characters that separate list elements. The default value is comma. Alias: delimiter |
, |
|
includeEmptyFields
boolean,
optional
|
edit
if false it cleans up empty fields. Introduced: 5.3.5.17 |
true |
Examples
edit//Simple Example
writeoutput(listPrepend("Susi,LAS,,lucee,,,test","Inserted"));
//Member Function
strList=",I,,love,lucee,,";
writeDump(strList.listPrepend("First"));
Multi-character delimiter
By default every character of delimiters is a delimiter. With multiCharacterDelimiter=true the whole string is one delimiter.
writeOutput( listPrepend( "2, 3", 1, ", ", true, true ) ); // 1, 2, 3
See also
- Lists
- Strings
- string.listPrepend()
- Search Issue Tracker open_in_new
- Search Lucee Test Cases open_in_new (good for further, detailed examples)