1<!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=utf-8"> 5<meta http-equiv="Content-Style-Type" content="text/css"> 6<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> 7<title>FatFs - f_rename</title> 8</head> 9 10<body> 11 12<div class="para func"> 13<h2>f_rename</h2> 14<p>The f_rename function renames and/or moves a file or sub-directory.</p> 15<pre> 16FRESULT f_rename ( 17 const TCHAR* <span class="arg">old_name</span>, <span class="c">/* [IN] Old object name */</span> 18 const TCHAR* <span class="arg">new_name</span> <span class="c">/* [IN] New object name */</span> 19); 20</pre> 21</div> 22 23<div class="para arg"> 24<h4>Parameters</h4> 25<dl class="par"> 26<dt>old_name</dt> 27<dd>Pointer to a null-terminated string that specifies the existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd> 28<dt>new_name</dt> 29<dd>Pointer to a null-terminated string that specifies the new object name. A drive number may be specified in this string but it is ignored and assumed as the same drive of the <tt class="arg">old_name</tt>. Any object with this path name except <tt class="arg">old_name</tt> must not be exist, or the function fails with <tt>FR_EXIST</tt>.</dd> 30</dl> 31</div> 32 33 34<div class="para ret"> 35<h4>Return Values</h4> 36<p> 37<a href="rc.html#ok">FR_OK</a>, 38<a href="rc.html#de">FR_DISK_ERR</a>, 39<a href="rc.html#ie">FR_INT_ERR</a>, 40<a href="rc.html#nr">FR_NOT_READY</a>, 41<a href="rc.html#ok">FR_NO_FILE</a>, 42<a href="rc.html#np">FR_NO_PATH</a>, 43<a href="rc.html#in">FR_INVALID_NAME</a>, 44<a href="rc.html#ex">FR_EXIST</a>, 45<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, 46<a href="rc.html#id">FR_INVALID_DRIVE</a>, 47<a href="rc.html#ne">FR_NOT_ENABLED</a>, 48<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, 49<a href="rc.html#tm">FR_TIMEOUT</a>, 50<a href="rc.html#lo">FR_LOCKED</a>, 51<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> 52</p> 53</div> 54 55 56<div class="para desc"> 57<h4>Description</h4> 58<p>Renames a file or sub-directory and can also move it to other directory in the same volume. The object to be renamed must not be an open object, or <em>the FAT volume can be collapsed</em>. Such the wrong operation is rejected safely when <a href="appnote.html#dup">file lock function</a> is enabled.</p> 59</div> 60 61 62<div class="para comp"> 63<h4>QuickInfo</h4> 64<p>Available when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 0</tt> and <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> == 0</tt>.</p> 65</div> 66 67 68<div class="para use"> 69<h4>Example</h4> 70<pre> 71 <span class="c">/* Rename an object in the default drive */</span> 72 <em>f_rename</em>("oldname.txt", "newname.txt"); 73 74 <span class="c">/* Rename an object in the drive 2 */</span> 75 <em>f_rename</em>("2:oldname.txt", "newname.txt"); 76 77 <span class="c">/* Rename an object and move it to another directory in the drive */</span> 78 <em>f_rename</em>("log.txt", "old/log0001.txt"); 79</pre> 80</div> 81 82 83<p class="foot"><a href="../00index_e.html">Return</a></p> 84</body> 85</html> 86