MACROMEDIA COLFUSION MX 7-CFML, Reference

Page: 730 / 1108

730 Chapter 3: ColdFusion Functions
ListPrepend
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
ListAppend
,
ListInsertAt
,
ListSetAt
; “Lists” in Chapter 3, “Using ColdFusion Variables,” in
ColdFusion MX Developer’s Guide
Parameters
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
<!--- This example shows ListPrepend --->
<cfquery name = "GetParkInfo" datasource = "cfdocexamples">
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") >
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. Character(s) 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.