Choose a tag:

see all tags

Tag <CFDIRECTORY>

Body

Example

	<cfdirectory
		[action="string"]
		[createpath="boolean"]
		[destination="string"]
		directory="string"
		[filter="any"]
		[filterdelimiters="string"]
		[listinfo="string"]
		[mode="string"]
		[name="string"]
		[nameconflict="string"]
		[newdirectory="string"]
		[recurse="boolean"]
		[serverpassword="string"]
		[sort="string"]
		[storeacl="object"]
		[storelocation="string"]
		[type="string"]>
	

	<cfscript>
		directory
		[action="string"]
		[createpath="boolean"]
		[destination="string"]
		directory="string"
		[filter="any"]
		[filterdelimiters="string"]
		[listinfo="string"]
		[mode="string"]
		[name="string"]
		[nameconflict="string"]
		[newdirectory="string"]
		[recurse="boolean"]
		[serverpassword="string"]
		[sort="string"]
		[storeacl="object"]
		[storelocation="string"]
		[type="string"];
	</cfscript>

Attributes

Name	Type	Required	Description
action	string	No	Defines the action to be taken with directory(ies) specified in directory.
createpath	boolean	No	if set to false, expects all parent directories to exist, true (default) will generate necessary directories
destination	string	No	Required for action = "copy". Ignored by all other actions. Path of the destination directory. If not an absolute path, it is relative to the source directory.
directory	string	Yes	The name of the directory to perform the action against.
filter	any	No	Optional for action = "list". Ignored by all other actions. Can be either a wildcard filter, e.g. "m*", or a UDF/Closure which accepts the file/directory name and returns a boolean value to indicate whether that item should be included in the result or not.
filterdelimiters	string	No	Optional when passing a filter pattern. This value is used as a delimiter for the patterns. Default is the pipe "|" character.
listinfo	string	No	- all: includes all information in the result set. - name: includes only filenames in the result set.
mode	string	No	Used with action = "Create" to define the permissions for a directory on UNIX and Linux platforms. Ignored on Windows. Options correspond to the octal values of the UNIX chmod command. From left to right, permissions are assigned for owner, group, and other.
name	string	No	Required for action = "list". Ignored by all other actions. Name of output query for directory listing.
nameconflict	string	No	When used with action="copy" the possible values are: [Overwrite]|Error. When used with action="create" the possible values are: [Error]|Skip. Ignored for all other actions.
newdirectory	string	No	Required for action = "rename". Ignored by all other actions. The new name of the directory specified in the directory attribute.
recurse	boolean	No	Whether Lucee performs the action on subdirectories
serverpassword	string	No	allow you to access filesystem, also when access is denied for your context
sort	string	No	Optional for action = "list". Ignored by all other actions. The query columns by which to sort the directory listing. Any combination of columns from query output can be specified in comma-separated list. You can specify ASC (ascending) or DESC (descending) as qualifiers for column names. ASC is the default
storeacl	any	No	An array of struct where each struct represents a permission or grant. Example: [{email="[email protected]", permission="full_control"}, {group="all", permission="read"}]
storelocation	string	No	Only used for S3 Resources. The location of the created bucket/object. The location can either be EU,US or US-WEST. The default location is US.
type	string	No	- file: includes only filenames. - dir: includes only directory names. - all: includes both filenames and directory names.