| 1 |
606 |
jeremybenn |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
|
|
<html lang="en">
|
| 3 |
|
|
<head>
|
| 4 |
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
| 5 |
|
|
<meta http-equiv="Content-Style-Type" content="text/css">
|
| 6 |
|
|
<link rel="up" title="FatFs" href="../00index_e.html">
|
| 7 |
|
|
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
|
| 8 |
|
|
<title>FatFs - f_rename</title>
|
| 9 |
|
|
</head>
|
| 10 |
|
|
|
| 11 |
|
|
<body>
|
| 12 |
|
|
|
| 13 |
|
|
<div class="para">
|
| 14 |
|
|
<h2>f_rename</h2>
|
| 15 |
|
|
<p>Renames an object.</p>
|
| 16 |
|
|
<pre>
|
| 17 |
|
|
FRESULT f_rename (
|
| 18 |
|
|
const XCHAR* <em>OldName</em>, /* Pointer to old object name */
|
| 19 |
|
|
const XCHAR* <em>NewName</em> /* Pointer to new object name */
|
| 20 |
|
|
);
|
| 21 |
|
|
</pre>
|
| 22 |
|
|
</div>
|
| 23 |
|
|
|
| 24 |
|
|
<div class="para">
|
| 25 |
|
|
<h4>Parameters</h4>
|
| 26 |
|
|
<dl class="par">
|
| 27 |
|
|
<dt>OldName</dt>
|
| 28 |
|
|
<dd>Pointer to a null-terminated string specifies the old <a href="filename.html">object name</a> to be renamed.</dd>
|
| 29 |
|
|
<dt>NewName</dt>
|
| 30 |
|
|
<dd>Pointer to a null-terminated string specifies the new object name without drive number.</dd>
|
| 31 |
|
|
</dl>
|
| 32 |
|
|
</div>
|
| 33 |
|
|
|
| 34 |
|
|
|
| 35 |
|
|
<div class="para">
|
| 36 |
|
|
<h4>Return Values</h4>
|
| 37 |
|
|
<dl class="ret">
|
| 38 |
|
|
<dt>FR_OK (0)</dt>
|
| 39 |
|
|
<dd>The function succeeded.</dd>
|
| 40 |
|
|
<dt>FR_NO_FILE</dt>
|
| 41 |
|
|
<dd>Could not find the old name.</dd>
|
| 42 |
|
|
<dt>FR_NO_PATH</dt>
|
| 43 |
|
|
<dd>Could not find the path.</dd>
|
| 44 |
|
|
<dt>FR_INVALID_NAME</dt>
|
| 45 |
|
|
<dd>The file name is invalid.</dd>
|
| 46 |
|
|
<dt>FR_INVALID_DRIVE</dt>
|
| 47 |
|
|
<dd>The drive number is invalid.</dd>
|
| 48 |
|
|
<dt>FR_NOT_READY</dt>
|
| 49 |
|
|
<dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
|
| 50 |
|
|
<dt>FR_EXIST</dt>
|
| 51 |
|
|
<dd>The new name is colliding with an existing name.</dd>
|
| 52 |
|
|
<dt>FR_DENIED</dt>
|
| 53 |
|
|
<dd>The new name could not be created due to any reason.</dd>
|
| 54 |
|
|
<dt>FR_WRITE_PROTECTED</dt>
|
| 55 |
|
|
<dd>The medium is write protected.</dd>
|
| 56 |
|
|
<dt>FR_DISK_ERR</dt>
|
| 57 |
|
|
<dd>The function failed due to an error in the disk function.</dd>
|
| 58 |
|
|
<dt>FR_INT_ERR</dt>
|
| 59 |
|
|
<dd>The function failed due to a wrong FAT structure or an internal error.</dd>
|
| 60 |
|
|
<dt>FR_NOT_ENABLED</dt>
|
| 61 |
|
|
<dd>The logical drive has no work area.</dd>
|
| 62 |
|
|
<dt>FR_NO_FILESYSTEM</dt>
|
| 63 |
|
|
<dd>There is no valid FAT volume on the disk.</dd>
|
| 64 |
|
|
</dl>
|
| 65 |
|
|
</div>
|
| 66 |
|
|
|
| 67 |
|
|
|
| 68 |
|
|
<div class="para">
|
| 69 |
|
|
<h4>Description</h4>
|
| 70 |
|
|
<p>Renames an object and can also move it to other directory. The logical drive number is determined by old name, new name must not contain a logical drive number. <em>Do not rename open objects</em>.</p>
|
| 71 |
|
|
</div>
|
| 72 |
|
|
|
| 73 |
|
|
|
| 74 |
|
|
<div class="para">
|
| 75 |
|
|
<h4>QuickInfo</h4>
|
| 76 |
|
|
<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>
|
| 77 |
|
|
</div>
|
| 78 |
|
|
|
| 79 |
|
|
|
| 80 |
|
|
<div class="para">
|
| 81 |
|
|
<h4>Example</h4>
|
| 82 |
|
|
<pre>
|
| 83 |
|
|
/* Rename an object */
|
| 84 |
|
|
f_rename("oldname.txt", "newname.txt");
|
| 85 |
|
|
|
| 86 |
|
|
/* Rename and move an object to other directory */
|
| 87 |
|
|
f_rename("oldname.txt", "dir1/newname.txt");
|
| 88 |
|
|
</pre>
|
| 89 |
|
|
</div>
|
| 90 |
|
|
|
| 91 |
|
|
<p class="foot"><a href="../00index_e.html">Return</a></p>
|
| 92 |
|
|
</body>
|
| 93 |
|
|
</html>
|
