CFDIRECTORY | ||||||||
Description | ||||||||
Manages interactions with directories. | ||||||||
Category | ||||||||
File management tags | ||||||||
Syntax<cfdirectory action = "directory action" directory = "directory name" name = "query name" filter = "list filter" mode = "permission" sort = "sort specification" newDirectory = "new directory name"> |
||||||||
See also | ||||||||
cffile | ||||||||
History | ||||||||
ColdFusion MX:
|
||||||||
Usage
|
||||||||
If you put ColdFusion applications on a server that is used by multiple customers, you must consider the security of files and directories that could be uploaded or otherwise manipulated with this tag by unauthorized users. For more information about securing ColdFusion tags, see Configuring and Administering ColdFusion MX. | ||||||||
If action = "list", cfdirectory returns these result columns, which you can reference in a cfoutput tag:
|
||||||||
You can use the following result columns in standard CFML expressions, preceding the result column name with the query name:
#mydirectory.name# #mydirectory.size# #mydirectory.type# #mydirectory.dateLastModified# #mydirectory.attributes# #mydirectory.mode#
|
||||||||
The filter attribute specifies a pattern of one or more characters. All names that match that pattern are included in the list. On Windows systems, pattern matching ignores text case, on UNIX and Linux, pattern matches are case-sensitive. | ||||||||
The following 2 characters have special meaning in the pattern and are called metacharacters:
The following table shows examples of patterns and file names that they match:
|
||||||||
Example<h3>cfdirectory Example</h3> <!--- use cfdirectory to give the contents of the directory that contains this page order by name and size ---> <cfdirectory directory="#GetDirectoryFromPath(GetTemplatePath())#" name="myDirectory" sort="name ASC, size DESC"> <!---- Output the contents of the cfdirectory as a cftable -----> <cftable query="myDirectory" htmltable colheaders> <cfcol header="NAME:" text="#Name#"> <cfcol header="SIZE:" text="#Size#"> </cftable> |
ACTION | |
Optional | |
Default value: "List"
|
DIRECTORY | |
Required | |
Absolute pathname of directory against which to perform action. |
NAME | |
Required if action = "list" | |
Name for output record set. |
FILTER | |
Optional if action = "list" | |
File extension filter applied to returned names. For example: *.cfm. One filter can be applied. |
MODE | |
Optional | |
Used with action = "create". Permissions. Applies only to UNIX and Linux. Octal values of chmod command. Assigned to owner, group, and other, respectively. For example:
|
SORT | |
Optional; used if action = "list" | |
Default value: "ASC"
Query column(s) by which to sort directory listing. Delimited list of columns from query output. To qualify a column, use:
For example: sort = "dirname ASC, file2 DESC, size, datelastmodified" |
NEWDIRECTORY | |
Required if action = "rename" | |
New name for directory |