Deletes an element from a list.
A copy of the list, without the specified element.
ListDeleteAt(list, position [, delimiters ])
ListGetAt, ListSetAt, ListLen; Lists in Using ColdFusion Variables in ColdFusion MX Developer's Guide
| Parameter | Description |
|---|---|
|
list |
A list or a variable that contains one. |
|
position |
A positive integer or a variable that contains one. Position at which to delete element. The first list position is 1. |
|
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 processes each occurrence of each character as a delimiter. |
To use this and other functions with the default delimiter (comma), you can code as follows:
<cfset temp2 = ListDeleteAt(temp, "3")>
To specify another delimiter, you code as follows:
<cfset temp2 = ListDeleteAt(temp, "3", ";")>
ColdFusion ignores empty list elements; thus, the list "a,b,c,,,d" has four elements.
<!--- First, query to get some values for our list elements---> <CFQUERY NAME="GetParkInfo" DATASOURCE="cfdocexamples"> SELECT PARKNAME,CITY,STATE FROM Parks WHERE PARKNAME LIKE 'CHI%' </CFQUERY> <CFSET temp = ValueList(GetParkInfo.ParkName)> <CFSET deleted_element = ListGetAt(temp, "3", ",")> <cfoutput> <p>The original list: #temp# </cfoutput> <!--- Delete the third element from the list ---> <CFSET temp2 =ListDeleteAt(Temp, "3")> <cfoutput> <p>The changed list: #temp2# <p><I>This list element:<br>#deleted_element#<br> is no longer present
at position three of the list.</I> </cfoutput>