Whatever message this page gives is out now! Go check it out!
cffile action = "rename"
Last update:
May 18, 2026
Description
Renames or moves a file on the server.
Syntax
<cffile
action = "rename"
destination = "pathname"
source = "full pathname"
attributes = "file attributes list"
mode = "mode">cfscript equivalent of the syntax
<cfscript>
cffile(action = "rename" , destination = "pathname" , source = "full pathname" , attributes = "file attributes list" , mode = "mode")
</cfscript>Note: You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.
See also
History
See the History section of the main cffile tag page.
Attributes
Attribute | Req/Opt | Default | Description |
action | Required | Type of file manipulation that the tag performs. | |
destination | Required | Destination file or directory. If not an absolute path, it is relative to the source directory. | |
source | Required | Pathname of file to rename. If not an absolute path (starting with a drive letter and a colon, or a forward or backward slash), it is relative to the ColdFusion temporary directory, which is returned by the GetTempDirectory function. | |
attributes | Optional | Applies to Windows. A comma-delimited list of attributes to set on the file. If omitted, the file's attributes are maintained.Each value must be specified explicitly. For example, if attributes = "readOnly", all other attributes are overwritten.
| |
mode | Optional | Applies only to UNIX and Linux. Permissions. Octal values of UNIX chmod command. Assigned to owner, group, and other. For example:
|
Usage
The rename action renames or move a file. The destination attribute must be a pathname, not just a new name for the file. If the destination is a directory, the file is moved and not renamed.
Example
Windows example:
<!--- Source Document is read-only but when renamed it becomes normal (not hidden or
read-only). --->
<cffile action = "rename" source = "c:\files\memo\readonlymemo.doc"
destination = "c:\files\memo\normalmemo.doc" attributes="normal">UNIX example:
<cffile action = "rename" source = "#myWR#/memo/sample.txt"
destination = "#myWR#/memo/other_sample.txt" mode="666">
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
