84 lines
2.3 KiB
HTML
84 lines
2.3 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
<meta http-equiv="Content-Style-Type" content="text/css">
|
|
<link rel="up" title="FatFs" href="../00index_e.html">
|
|
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
|
|
<title>FatFs - f_rename</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="para">
|
|
<h2>f_rename</h2>
|
|
<p>Rename file or directory.</p>
|
|
<pre>
|
|
FRESULT f_rename (
|
|
const char* <em>OldName</em>, // Pointer to old object name
|
|
const char* <em>NewName</em> // Pointer to new object name
|
|
);
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="para">
|
|
<h4>Parameter</h4>
|
|
<dl class="par">
|
|
<dt>OldName</dt>
|
|
<dd>Pointer to a null-terminated string specifies the old object name to be renamed.</dd>
|
|
<dt>NewName</dt>
|
|
<dd>Pointer to a null-terminated string specifies the new object name. Existing name cannot be used.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>Return Values</h4>
|
|
<dl class="ret">
|
|
<dt>FR_OK (0)</dt>
|
|
<dd>The function succeeded.</dd>
|
|
<dt>FR_NO_FILE</dt>
|
|
<dd>Could not find the file or directory.</dd>
|
|
<dt>FR_NO_PATH</dt>
|
|
<dd>Could not find the path.</dd>
|
|
<dt>FR_INVALID_NAME</dt>
|
|
<dd>The file name is invalid.</dd>
|
|
<dt>FR_NOT_READY</dt>
|
|
<dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
|
|
<dt>FR_DENIED</dt>
|
|
<dd>The new name could not be created due to any reason.</dd>
|
|
<dt>FR_WRITE_PROTECTED</dt>
|
|
<dd>The medium is write protected.</dd>
|
|
<dt>FR_RW_ERROR</dt>
|
|
<dd>Any error occured in low level disk I/O.</dd>
|
|
<dt>FR_INCORRECT_DISK_CHANGE</dt>
|
|
<dd>Incorrect disk removal/change has occured.</dd>
|
|
<dt>FR_NOT_ENABLED</dt>
|
|
<dd>FatFs module is not enabled.</dd>
|
|
<dt>FR_NO_FILESYSTEM</dt>
|
|
<dd>There is no valid FAT partition on the disk.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>Description</h4>
|
|
<p>Rename a file or directory and can move it to other directory. This function is not supported in read-only configuration or minimization level of >= 1.</p>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>Example</h4>
|
|
<pre>
|
|
// Rename an object
|
|
f_rename("oldname.txt", "newname.txt");
|
|
|
|
// Rename and move to other directory simultaneously
|
|
f_rename("oldname.txt", "dir1/newname.txt");
|
|
</pre>
|
|
</div>
|
|
|
|
<p class="foot"><a href="../00index_e.html">Return</a></p>
|
|
</body>
|
|
</html>
|