Lucee Function Reference

structsort()

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.

Example

structsort(struct base,[string sortType,[string sortOrder,[string pathToSubElement]]]):array

Category

struct,sort

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Default Value Description
base struct  Yes   A structure with one field (an associative array).  
sortType string  No text define one of the following:
  • numeric: sorts numbers
  • text: sorts text alphabetically, taking case into account (case sensitive)
  • textnocase: sorts text alphabetically, without regard to case (case insensitive)  
    • sortOrder string  No asc sort direction:
    _- asc (default): ascending (a to z) sort order
  • desc: descending (z to a) sort order  
    • pathToSubElement string  No   String or a variable that contains one