Inserts an element at the beginning of a list.
A copy of the list, with value inserted at the first position.
ListPrepend(list, value [, delimiters ])
ListAppend,
ListInsertAt,
ListSetAt
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 empty (""), ColdFusion replaces the list with the contents of value
.
To add an element to the beginning or end of a list, Macromedia recommends that you do so with code such as the following, rather than with the listAppend
or listPrepend
functions:
<cfset MyValue = "another element"> <cfif listLen(myList) is 0>
<cfset myList = MyValue> <cfelse> <cfset myList = myList & ", " & MyValue> </cfif>
<!--- This example shows ListPrepend ---> <cfquery name = "GetParkInfo" datasource = "cfsnippets"> SELECT PARKNAME,CITY,STATE FROM PARKS WHERE PARKNAME LIKE 'DE%' </cfquery> <cfset temp = ValueList(GetParkInfo.ParkName)> <cfset first_element = ListFirst(temp)> <cfoutput><p>The original list: #temp#</cfoutput> <!--- now, insert an element at position 1---> <cfset temp2 = ListPrepend(Temp, "my Inserted Value")>