| <!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>Renames an object.</p> | |
| <pre> | |
| FRESULT f_rename ( | |
| const XCHAR* <em>OldName</em>, /* Pointer to old object name */ | |
| const XCHAR* <em>NewName</em> /* Pointer to new object name */ | |
| ); | |
| </pre> | |
| </div> | |
| <div class="para"> | |
| <h4>Parameters</h4> | |
| <dl class="par"> | |
| <dt>OldName</dt> | |
| <dd>Pointer to a null-terminated string specifies the old <a href="filename.html">object name</a> to be renamed.</dd> | |
| <dt>NewName</dt> | |
| <dd>Pointer to a null-terminated string specifies the new object name without drive number.</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 old name.</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_INVALID_DRIVE</dt> | |
| <dd>The drive number 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_EXIST</dt> | |
| <dd>The new name is colliding with an existing name.</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_DISK_ERR</dt> | |
| <dd>The function failed due to an error in the disk function.</dd> | |
| <dt>FR_INT_ERR</dt> | |
| <dd>The function failed due to a wrong FAT structure or an internal error.</dd> | |
| <dt>FR_NOT_ENABLED</dt> | |
| <dd>The logical drive has no work area.</dd> | |
| <dt>FR_NO_FILESYSTEM</dt> | |
| <dd>There is no valid FAT volume on the disk.</dd> | |
| </dl> | |
| </div> | |
| <div class="para"> | |
| <h4>Description</h4> | |
| <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> | |
| </div> | |
| <div class="para"> | |
| <h4>QuickInfo</h4> | |
| <p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p> | |
| </div> | |
| <div class="para"> | |
| <h4>Example</h4> | |
| <pre> | |
| /* Rename an object */ | |
| f_rename("oldname.txt", "newname.txt"); | |
| /* Rename and move an object to other directory */ | |
| f_rename("oldname.txt", "dir1/newname.txt"); | |
| </pre> | |
| </div> | |
| <p class="foot"><a href="../00index_e.html">Return</a></p> | |
| </body> | |
| </html> |