1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
5<meta http-equiv="Content-Style-Type" content="text/css" />
6<title>FS_RenameFile</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9<body>
10<h1>FS_RenameFile <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
11<h2>Syntax</h2>
12
13<pre><code>
14#include &lt;nitro/fs.h&gt;
15
16BOOL FS_RenameFile(const char *src, const char *dst);
17</code></pre>
18<h2>Arguments</h2>
19<table style="width:100%">
20<tbody>
21<tr>
22<td style="width:13%"><em><strong>src</strong></em></td>
23<td style="width:87%">Path name of the file before the change.</td>
24</tr>
25<tr>
26<td style="width:13%"><em><strong>dst</strong></em></td>
27<td style="width:87%">Path name of the file after the change.</td>
28</tr>
29</tbody>
30</table>
31
32<h2>Return Values</h2>
33<p>Returns TRUE if the file name was changed properly; returns FALSE otherwise. In case of failure, the error details can be obtained using <code><a href="../archive/FS_GetArchiveResultCode.html">FS_GetArchiveResultCode()</a></code>.</p>
34
35<h2>Description</h2>
36<p>Renames the specified file. This is the same as moving a file. The function returns FALSE in the following situations:
37</p>
38<ul>
39<li>If the target archive does not support renaming files</li>
40<li>If the file to be renamed does not exist</li>
41<li>If a file with the same name as the requested new name already exists</li>
42</ul>
43
44<h2>Note</h2>
45<ul>
46<li>This function cannot be called from the interrupt handler (IRQ mode). Also note that in some cases processing may not end if interrupts are left prohibited.</li>
47</ul>
48
49<h2>See Also</h2>
50<p><code><a href="../FS_PERMIT.html">FS_PERMIT_*</a> <br /> <a href="FS_CreateFile.html">FS_CreateFile</A> <a href="FS_DeleteFile.html">FS_DeleteFile</A> <a href="../file/FS_GetResultCode.html">FS_GetResultCode</A></code></p>
51
52<h2>Revision History</h2>
53<p>
542007/09/18 Initial version.
55</p>
56<hr><p>CONFIDENTIAL</p></body>
57</html>
58