cffile action = "rename"

Description

Renames a file on the server.

Syntax

<cffile 
  action = "rename"
  source = "full_path_name"
  destination = "full_path_name" 
  mode = "mode"
  attributes = "file_attributes_list">

History

New in ColdFusion MX: a directory path that you specify in the destination attribute does not require a trailing slash.

New in ColdFusion MX: on Windows platforms, the temporary, archive, and system options of the attributes attribute are deprecated. Do not use them in new applications. They might not work, and might cause an error, in later releases.

Attributes

Attribute Req/Opt Default Description

action
Required

Type of file manipulation that the tag performs.

source
Required

Absolute pathname of file on web server.
On Windows, use backward slashes; on UNIX, use forward slashes.

destination
Required

Absolute pathname of file on web server.
On Windows, use backward slashes; on UNIX, use forward slashes.

mode
Optional

Applies only to Solaris and HP-UX. 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

One attribute (Windows) or a comma-delimited list of attributes (other platforms) 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.

readOnly

hidden

normal

Attribute	Req/Opt	Description
action	Required	Type of file manipulation that the tag performs.
source	Required	Absolute pathname of file on web server. On Windows, use backward slashes; on UNIX, use forward slashes.
destination	Required	Absolute pathname of file on web server. On Windows, use backward slashes; on UNIX, use forward slashes.
mode	Optional	Applies only to Solaris and HP-UX. 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	One attribute (Windows) or a comma-delimited list of attributes (other platforms) 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. readOnly hidden normal

Example

The following example renames the file keymemo.doc to oldmemo.doc:

<cffile action = "rename"

  source = "c:\files\memo\keymemo.doc" 
  destination = "c:\files\memo\oldmemo.doc">