Lucee Function Reference

directorylist()

Lists the contents of a specified directory and returns the list as an array or a query.

Example

directorylist(string path,[boolean recurse,[string listInfo,[any filter,[string sort,[string type]]]]]):any

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Description
path string  Yes The absolute path of the directory for which to list the contents. This can be any type of supported virtual file systems.  
recurse boolean  No Specifies whether to include subdirectories in the listing. If `true`, the contents of all subdirectories are also listed.  
listInfo string  No Defines the return type of this function:
  • `name`: returns an array of names of files and directories.
  • `path`: returns an array of paths of files and directories.
  • `query`: returns a query object.  
    • filter any  No Specifies a filter to be used to filter the results:
  • A string that uses `*` as a wildcard, for example, `*.cfm`.
  • A UDF (User Defined Function) using the following pattern: `functionName(String path):boolean`. The function is run for every single file; if the function returns `true`, the file is included in the list; otherwise, it is omitted.  
    • sort string  No Specifies the columns by which to sort a directory listing. Use a comma-delimited list of columns from the query output. To specify sort order, qualify a column with one of the following values:
  • `asc`: ascending (a to z) sort order.
  • `desc`: descending (z to a) sort order.  
    • type string  No Specifies the type of results to return:
  • `file`: includes only filenames.
  • `dir`: includes only directory names.
  • `all`: includes both filenames and directory names.