mozilla

Revision 560259 of dirRename

  • Revision slug: Archive/Mozilla/XPInstall/Reference/File_Object/Methods/dirRename
  • Revision title: dirRename
  • Revision id: 560259
  • Created:
  • Creator: Sheppy
  • Is current revision? Yes
  • Comment Remove languageXPInstall_API_Reference/File_Object/Methods/dirRename Archive/Mozilla/XPInstall/Reference/File_Object/Methods/dirRename

Revision Content

dirRename

Renames a directory in place.

Method of

File object

Syntax

int dirRename( FileSpecObject directory, String newname );

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.

Returns

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

Revision Source

<h3 id="dirRename" name="dirRename">dirRename</h3>
<p>Renames a directory in place.</p>
<h4 id="Method_of" name="Method_of">Method of</h4>
<p><a href="en/XPInstall_API_Reference/File_Object">File</a> object</p>
<h4 id="Syntax" name="Syntax">Syntax</h4>
<pre>
int dirRename( FileSpecObject directory, String newname );
</pre>
<h4 id="Parameters" name="Parameters">Parameters</h4>
<p>The dirRename method has the following parameters:</p>
<dl>
  <dt>
    <code>directory</code></dt>
  <dd>
    A FileSpecObject representing the directory to be renamed.</dd>
  <dt>
    newname</dt>
  <dd>
    The new terminal (or leaf) name of the directory.</dd>
</dl>
<h4 id="Returns" name="Returns">Returns</h4>
<p>An integer error code. For a list of possible values, see <a href="en/XPInstall_API_Reference/Return_Codes"> Return Codes</a>.</p>
Revert to this revision