Adobe ColdFusion 8

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, includeEmptyFields])

See also

ArrayToList; "Using Arrays and Structures" in the ColdFusion Developer's Guide

Parameters

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.

includeEmptyField s

A Boolean value specifying whether to create empty array entries if there are two delimiters in a row.

  • false (Default) ignore empty elements in a list; for example, convert a,,c into an array with only two elements.
  • true  Convert empty elements in a list to empty array entries; for example, convert a,,c into an array with three elements, the second of which is empty.

Usage

Oct 7, 2008: Modified
ColdFusion, by default, ignores empty list 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
FROMMessages
</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.