mozilla

Compare Revisions

nsIFile

Change Revisions

Revision 332433:

Revision 332433 by P.A. on

Revision 522813:

Revision 522813 by Yuan.Xulei on

Title:
nsIFile
nsIFile
Slug:
XPCOM_Interface_Reference/nsIFile
XPCOM_Interface_Reference/nsIFile
Tags:
"File I/O", "XPCOM", "Interfaces", "XPCOM API Reference", "XPCOM Interface Reference", "Interfaces:Scriptable"
"File I/O", "XPCOM", "Interfaces", "XPCOM API Reference", "XPCOM Interface Reference", "Interfaces:Scriptable"
Content:

Revision 332433
Revision 522813
n42            <code>void <a href="/en/XPCOM_Interface_Reference/nsIn42            <code>void <a href="/en/XPCOM_Interface_Reference/nsI
>LocalFile#appendRelativeNativePath()" title="/en/XPCOM_Interface_>LocalFile#appendRelativeNativePath()" title="/en/XPCOM_Interface_
>Reference/nsILocalFile#appendRelativeNativePath()">appendRelative>Reference/nsILocalFile#appendRelativeNativePath()">appendRelative
>NativePath</a>(in ACString relativeFilePath);</code> {{ noscript_>NativePath</a>(in ACString relativeFilePath);</code> {{ gecko_min
>inline() }}{{ gecko_minversion_inline("14") }}>version_inline("14") }}
n112            <code>void <a href="/en/XPCOM_Interface_Reference/nsIn112            <code>void <a href="/en/XPCOM_Interface_Reference/nsI
>LocalFile#initWithNativePath()" title="/en/XPCOM_Interface_Refere>LocalFile#initWithNativePath()" title="/en/XPCOM_Interface_Refere
>nce/nsILocalFile#initWithNativePath()">initWithNativePath</a>(in >nce/nsILocalFile#initWithNativePath()">initWithNativePath</a>(in 
>ACString filePath);</code> {{ noscript_inline() }}{{ gecko_minver>ACString filePath);</code> {{ gecko_minversion_inline("14") }}
>sion_inline("14") }} 
n167            <code>PRLibraryStar <a href="/en/XPCOM_Interface_Refen167            <code>PRLibraryStar <a href="/en/XPCOM_Interface_Refe
>rence/nsILocalFile#load()" title="/en/XPCOM_Interface_Reference/n>rence/nsILocalFile#load()" title="/en/XPCOM_Interface_Reference/n
>sILocalFile#load()">load</a>();</code> {{ noscript_inline() }}{{ >sILocalFile#load()">load</a>();</code> {{ gecko_minversion_inline
>gecko_minversion_inline("14") }}>("14") }}
n187            <code>FILE <a href="/en/XPCOM_Interface_Reference/nsIn187            <code>FILE <a href="/en/XPCOM_Interface_Reference/nsI
>LocalFile#openANSIFileDesc()" title="/en/XPCOM_Interface_Referenc>LocalFile#openANSIFileDesc()" title="/en/XPCOM_Interface_Referenc
>e/nsILocalFile#openANSIFileDesc()">openANSIFileDesc</a>(in string>e/nsILocalFile#openANSIFileDesc()">openANSIFileDesc</a>(in string
> mode);</code> {{ noscript_inline() }}{{ gecko_minversion_inline(> mode);</code> {{ gecko_minversion_inline("14") }}
>"14") }} 
188          </td>
189        </tr>
190        <tr>
191          <td>188          </td>
189        </tr>
190        <tr>
191          <td>
192            <code>PRFileDescStar <a href="/en/XPCOM_Interface_Ref192            <code>PRFileDescStar <a href="/en/XPCOM_Interface_Ref
>erence/nsILocalFile#openNSPRFileDesc()" title="/en/XPCOM_Interfac>erence/nsILocalFile#openNSPRFileDesc()" title="/en/XPCOM_Interfac
>e_Reference/nsILocalFile#openNSPRFileDesc()">openNSPRFileDesc</a>>e_Reference/nsILocalFile#openNSPRFileDesc()">openNSPRFileDesc</a>
>(in long flags, in long mode);</code> {{ noscript_inline() }}{{ g>(in long flags, in long mode);</code> {{ gecko_minversion_inline(
>ecko_minversion_inline("14") }}>"14") }}
193          </td>
194        </tr>
195        <tr>
196          <td>
197            <code>void <a href="#renameTo()">renameTo</a>(in nsIF
 >ile newParentDir, in AString newName);</code> {{ gecko_minversion
 >_inline("30") }}
tt1419    <h3 id="renameTo()" name="renameTo()">
1420      renameTo()
1421    </h3>
1422    <p>
1423      This method moves this file to a new location within the sa
 >me volume.
1424    </p>
1425    <p>
1426      This method is identical to <a href="#moveTo()">moveTo</a> 
 >except that if this file or directory is moved to a a different v
 >olume, it fails and if this method succeeds, this instance will n
 >ot updated to point to the new file.
1427    </p>
1428    <pre class="eval">
1429void renameTo(
1430  in nsIFile newParentDir,
1431  in AString newName
1432);
1433</pre>
1434    <h6 id="Parameters" name="Parameters">
1435      Parameters
1436    </h6>
1437    <dl>
1438      <dt>
1439        <code>newParentDir</code>
1440      </dt>
1441      <dd>
1442        This parameter specifies the parent directory to move the
 > file into. If this parameter is <code>null</code>, then the pare
 >nt directory of the file will be used.
1443      </dd>
1444      <dt>
1445        <code>newName</code>
1446      </dt>
1447      <dd>
1448        This parameter allows you to specify a new leaf name for 
 >the file to be moved. This parameter may be empty, in which case 
 >the current leaf name will be used.
1449      </dd>
1450    </dl>
1451    <h6 id="Exceptions_thrown" name="Exceptions_thrown">
1452      Exceptions thrown
1453    </h6>
1454    <dl>
1455      <dt>
1456        <code>NS_ERROR_FILE_TARGET_DOES_NOT_EXIST</code>
1457      </dt>
1458      <dd>
1459        Indicates that the current file path does not exist. It i
 >s not possible to move a file that does not exist.
1460      </dd>
1461      <dt>
1462        <code>NS_ERROR_FILE_DIR_NOT_EMPTY</code>
1463      </dt>
1464      <dd>
1465        Indicates that an attempt was made to move a directory to
 > the location of an existing directory that is not empty.
1466      </dd>
1467      <dt>
1468        <code>NS_ERROR_FILE_ACCESS_DENIED</code>
1469      </dt>
1470      <dd>
1471        Indicates that an attempt was made to move file across vo
 >lumes, or to move a directory to the location of an existing dire
 >ctory that is not writable.
1472      </dd>
1473      <dt>
1474        <code>NS_ERROR_FILE_DESTINATION_NOT_DIR</code>
1475      </dt>
1476      <dd>
1477        Indicates that "newParentDir" exists and is not a directo
 >ry.
1478      </dd>
1479    </dl>

Back to History