Description
Inserts a string at the beginning and end of list elements.
Returns
A copy of the list, with qualifier before and after the specified elements.
Category
Function syntax
ListQualify(list, qualifier [, delimiters, elements, includeEmptyFields ])
See also
Lists in Using ColdFusion Variables in the Developing ColdFusion Applications
History
ColdFusion (2018 release): Introduced named parameters.
ColdFusion MX: Changed behavior: as the elements parameter value, you must specify "all" or "char"; otherwise, ColdFusion throws an exception. (In earlier releases, the function ignored an invalid value, and used "all"; this was inconsistent with other functions.)
Parameters
Parameter |
Description |
|---|---|
includeEmptyFields |
Optional. Set to yes to include empty values. |
list |
A list or a variable that contains one. |
qualifier |
A string or a variable that contains one. Character or string to insert before and after the list elements specified in the elements parameter. |
delimiters |
A string or a variable that contains one. Characters that separate list elements. The default value is comma. If this parameter contains more than one character, ColdFusion uses the first character as the delimiter and ignores the remaining characters. |
elements |
|
Usage
The new list might not preserve all of the delimiters in the list.ColdFusion ignores empty list elements; thus, the list "a,b,c,,,d" has four elements.
Example
<cfscript>
myList="Tokyo,Bangkok,Jakarta,Manila,Bangalore,Shanghai";
myQualify1=ListQualify(myList,"|");
myQualify2=ListQualify(myList,"@","a");
myQualify3=ListQualify(myList,"$"," ");
WriteOutput((myQualify1) & " "); // Qualifier | at the beginning and end of each item in the list
WriteOutput((myQualify2) & " "); // Qualifier @ at the beginning and end of the list; also @ at the beginning
// and end of the letter "a" in a list item
WriteOutput(myQualify3); // Qualifier $ at the beginning and end of the list
</cfscript>
Output
|Tokyo|,|Bangkok|,|Jakarta|,|Manila|,|Bangalore|,|Shanghai| @Tokyo,B@a@ngkok,J@a@k@a@rt@a@,M@a@nil@a@,B@a@ng@a@lore,Sh@a@ngh@a@i@ $Tokyo,Bangkok,Jakarta,Manila,Bangalore,Shanghai$
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online