rename

This is an archived page. It's not actively maintained.

Summary

Renames a specified file in place.

Method of

File object

Syntax

int rename( FileSpecObject file, String newname )

Parameters

The rename method has the following parameters:

file
A FileSpecObject representing the file to be renamed.
newname
The new terminal (or leaf) name of the file.

Returns

An integer error code. For a list of possible values, see Return Codes.