Lucee Function Reference

Function DIRECTORYCOPY

Copies the contents of a directory to a destination directory.

Example

directorycopy(string source,string destination,[boolean recurse,[any filter,[boolean createPath]]]):void

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Default Value Description
source string  Yes   Pathname of directory from which you copy content.  
destination string  Yes   Path of the destination directory. If not an absolute path, it is relative to the source directory.  
recurse boolean  No false If true, copies the subdirectories, otherwise only the files in the source directory.  
filter any  No   Filter to be used to filter the data copied:
  • 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, then the file is will be added to the list otherwise it will be omitted  
  • createPath boolean  No   if set to false, expects all parent directories to exist, true (default) will generate necessary directories