listAppend

Description

Concatenates a list or element to a list.

Categories

Related

Syntax

ListAppend(list, value [, delimiters ])

Attributes

AttributeDescriptionRequiredDefault
delimitersA 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 uses only the first character.
listA list or a variable that contains one.
valueAn element or a list of elements.

Returns

A copy of the list, with value appended. If delimiter = "", returns a copy of the list, unchanged.

Usage

ColdFusion inserts a delimiter character before value.
The following table shows examples of ListAppend processing:
Statement
Output
Comment
ListAppend('elem1,elem2', ' )
elem1,elem2,
Appended element is empty; delimiter is last character in list; list length is 2.
ListAppend(', 'elem1,elem2' )
elem1,elem2
List length is 2.
ListAppend("one___two", "three", "___")
"one___two_three"
Inserted the first character of delimiters before "three."

Example

<h3>ListAppend Example</h3> 
<!--- First, query to get some values for our list elements---> 
<cfquery name = "GetParkInfo" datasource = "cfdocexamples"> 
    SELECT PARKNAME,CITY,STATE 
    FROM PARKS WHERE PARKNAME LIKE 'AL%' 
</cfquery> 
<cfset temp = ValueList(GetParkInfo.ParkName)> 
<cfoutput> 
The original list: #temp# 
</cfoutput> 
<!--- now, append a park name to the list ---> 
<cfset temp2 = ListAppend(Temp, "ANOTHER PARK")>