Description

Inserts an element at the beginning of a list.

Returns

A copy of the list_,_ with value inserted at the first position.

Category

List functions

Function syntax

ListPrepend(list, value [, delimiters ])

See also

ListAppendListInsertAtListSetAtLists in Data types- Developing guide in the Developing ColdFusion Applications

Parameters

Parameter

Description

list

A list or a variable that contains one.

value

An element or a list of elements.

delimiters

A string or a variable that contains one. Characters that separate list elements. The default value is comma. If this parameter contains more than one character, ColdFusion only uses the first character and ignores the others.

Usage

When prepending an element to a list, ColdFusion inserts a delimiter. If delimiters_ contains more_ than one delimiter character, ColdFusion uses the first delimiter in the string; if delimiters is omitted, ColdFusion uses a comma.ColdFusion ignores empty list elements; thus, the list "a,b,c,,,d" has four elements.If the delimiters parameter is the empty string (""), ColdFusion returns the contents of the value parameter.

Example

<cfscript>
       myList="Tokyo,Bangkok,Jakarta,Manila,Bangalore,Shanghai";
       myAppend=ListPrepend(myList,"Singapore");
       WriteOutput(myAppend); // Inserts Singapore at the beginning of the list
</cfscript>

Output

Singapore,Tokyo,Bangkok,Jakarta,Manila,Bangalore,Shanghai

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy