User Guide

738 Chapter 3: ColdFusion Functions
ListToArray
Description
Copies the elements of a list to an array.
Returns
An array
Category
Array functions, Conversion functions, List functions
Function syntax
ListToArray(list [, delimiters ])
See also
ArrayToList
; Chapter 5, “Using Arrays and Structures,” in ColdFusion MX Developer’s Guide
Parameters
Usage
ColdFusion ignores empty list elements; thus, the list "a,b,c,,,d" has four elements.
ColdFusion treats each character in the
delimiters parameter as a separate delimiter. Therefore,
if the parameter is ",+" ColdFusion will break the list at either a comma or a plus sign.
Example
<h3>ListToArray Example</h3>
<!--- Find a list of users who wrote messages --->
<cfquery name = "GetMessageUser" datasource = "cfdocexamples">
SELECT Username, Subject, Posted
FROM Messages
</cfquery>
<cfset myList = ValueList(GetMessageUser.UserName)>
<p>My list is a list with <cfoutput>#ListLen(myList)#</cfoutput>
elements.
<cfset myArrayList = ListToArray(myList)>
<p>My array list is an array with <cfoutput>#ArrayLen(myArrayList)#
</cfoutput> elements.
Parameter Description
list A list or a variable that contains one.
You define a list variable with a
cfset statement.
delimiters A string or a variable that contains one. ColdFusion treats each character in the
string as a delimiter. The default value is comma.