User Guide

714 Chapter 3: ColdFusion Functions
StructSort
Description
Returns a sorted array of the top level keys in a structure. Sorts using alphabetic or numeric
sorting, and can sort based on the values of any structure element.
Returns
An array of top-level key names (strings), sorted by the value of the specified subelement.
Category
Structure functions
Function syntax
StructSort(base, sortType, sortOrder, pathToSubElement)
See also
Structure functions
Parameters
Usage
The pathToSubElement string does not support array notation, and only supports substructures
of structures.
This function does not sort or change the structure.
Example
<cfscript>
salaries = StructNew() ;
employees = StructNew() ;
departments = StructNew() ;
for ( i=1; i lt 6; i=i+1 )
{
salary = 120000 - i*10000 ;
salaries["employee#i#"] = salary ;
employee = StructNew() ;
employee["salary"] = salary ;
// employee.salary = salary ;
employees["employee#i#"] = employee ;
Parameter Description
base A ColdFusion struct with one field (an associative array).
sortType • numeric
• text: case sensitive (all lower-case letters precede the first upper-case
letter). Default.
• textnocase
sortOrder • asc: ascending (a to z) sort order. Default.
• desc: descending (z to a) sort order
pathToSubElement String or a variable that contains one.
Path to apply to each top-level key, to reach element value by which to sort.
Default: nothing (top-level entries sorted by their own values).