Visit Mozilla.org

XPInstall API Reference:File Object:Methods:dirRename

From MDC

Contents

[edit] dirRename

Renames a directory in place.

[edit] Method of

File object

[edit] Syntax

int dirRename( FileSpecObject directory, String newname );

[edit] Parameters

The dirRename method has the following parameters:

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

[edit] Returns

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