CFFILE ACTION = "RENAME"  
Description

Renames or moves a file on the server.

 
Syntax
<cffile 
   action = "rename"
   source = "full_path_name"
   destination = "path_name" 
   mode = "mode"
   attributes = "file_attributes_list">
 
See also

cfdirectory

 
History

See the History section of the main cffile tag page.

 
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">
ACTION  
  Required
 

Type of file manipulation that the tag performs.

SOURCE  
  Required
 

Pathname of file to rename.

If not an absolute path (starting a 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.
DESTINATION  
  Required
 

Destination file or directory. If not an absolute path, it is relative to the source directory.

MODE  
  Optional
 

Applies only to UNIX and Linux. Permissions. Octal values of UNIX chmod command. Assigned to owner, group, and other. For example:

  • 644: assigns read/write permission to owner; read permission to group and other.
  • 777: assigns read/write/execute permission to all.
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.

  • hidden
  • normal
  • readOnly