1e6865dcdSopenharmony_ci<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> 2e6865dcdSopenharmony_ci<html lang="en"> 3e6865dcdSopenharmony_ci<head> 4e6865dcdSopenharmony_ci<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 5e6865dcdSopenharmony_ci<meta http-equiv="Content-Style-Type" content="text/css"> 6e6865dcdSopenharmony_ci<link rel="up" title="FatFs" href="../00index_e.html"> 7e6865dcdSopenharmony_ci<link rel="alternate" hreflang="ja" title="Japanese" href="../ja/rename.html"> 8e6865dcdSopenharmony_ci<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> 9e6865dcdSopenharmony_ci<title>FatFs - f_rename</title> 10e6865dcdSopenharmony_ci</head> 11e6865dcdSopenharmony_ci 12e6865dcdSopenharmony_ci<body> 13e6865dcdSopenharmony_ci 14e6865dcdSopenharmony_ci<div class="para func"> 15e6865dcdSopenharmony_ci<h2>f_rename</h2> 16e6865dcdSopenharmony_ci<p>The f_rename function renames and/or moves a file or sub-directory.</p> 17e6865dcdSopenharmony_ci<pre> 18e6865dcdSopenharmony_ciFRESULT f_rename ( 19e6865dcdSopenharmony_ci const TCHAR* <span class="arg">old_name</span>, <span class="c">/* [IN] Old object name */</span> 20e6865dcdSopenharmony_ci const TCHAR* <span class="arg">new_name</span> <span class="c">/* [IN] New object name */</span> 21e6865dcdSopenharmony_ci); 22e6865dcdSopenharmony_ci</pre> 23e6865dcdSopenharmony_ci</div> 24e6865dcdSopenharmony_ci 25e6865dcdSopenharmony_ci<div class="para arg"> 26e6865dcdSopenharmony_ci<h4>Parameters</h4> 27e6865dcdSopenharmony_ci<dl class="par"> 28e6865dcdSopenharmony_ci<dt>old_name</dt> 29e6865dcdSopenharmony_ci<dd>Pointer to a null-terminated string that specifies the existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd> 30e6865dcdSopenharmony_ci<dt>new_name</dt> 31e6865dcdSopenharmony_ci<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> 32e6865dcdSopenharmony_ci</dl> 33e6865dcdSopenharmony_ci</div> 34e6865dcdSopenharmony_ci 35e6865dcdSopenharmony_ci 36e6865dcdSopenharmony_ci<div class="para ret"> 37e6865dcdSopenharmony_ci<h4>Return Values</h4> 38e6865dcdSopenharmony_ci<p> 39e6865dcdSopenharmony_ci<a href="rc.html#ok">FR_OK</a>, 40e6865dcdSopenharmony_ci<a href="rc.html#de">FR_DISK_ERR</a>, 41e6865dcdSopenharmony_ci<a href="rc.html#ie">FR_INT_ERR</a>, 42e6865dcdSopenharmony_ci<a href="rc.html#nr">FR_NOT_READY</a>, 43e6865dcdSopenharmony_ci<a href="rc.html#ok">FR_NO_FILE</a>, 44e6865dcdSopenharmony_ci<a href="rc.html#np">FR_NO_PATH</a>, 45e6865dcdSopenharmony_ci<a href="rc.html#in">FR_INVALID_NAME</a>, 46e6865dcdSopenharmony_ci<a href="rc.html#ex">FR_EXIST</a>, 47e6865dcdSopenharmony_ci<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, 48e6865dcdSopenharmony_ci<a href="rc.html#id">FR_INVALID_DRIVE</a>, 49e6865dcdSopenharmony_ci<a href="rc.html#ne">FR_NOT_ENABLED</a>, 50e6865dcdSopenharmony_ci<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, 51e6865dcdSopenharmony_ci<a href="rc.html#tm">FR_TIMEOUT</a>, 52e6865dcdSopenharmony_ci<a href="rc.html#lo">FR_LOCKED</a>, 53e6865dcdSopenharmony_ci<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> 54e6865dcdSopenharmony_ci</p> 55e6865dcdSopenharmony_ci</div> 56e6865dcdSopenharmony_ci 57e6865dcdSopenharmony_ci 58e6865dcdSopenharmony_ci<div class="para desc"> 59e6865dcdSopenharmony_ci<h4>Description</h4> 60e6865dcdSopenharmony_ci<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> 61e6865dcdSopenharmony_ci</div> 62e6865dcdSopenharmony_ci 63e6865dcdSopenharmony_ci 64e6865dcdSopenharmony_ci<div class="para comp"> 65e6865dcdSopenharmony_ci<h4>QuickInfo</h4> 66e6865dcdSopenharmony_ci<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> 67e6865dcdSopenharmony_ci</div> 68e6865dcdSopenharmony_ci 69e6865dcdSopenharmony_ci 70e6865dcdSopenharmony_ci<div class="para use"> 71e6865dcdSopenharmony_ci<h4>Example</h4> 72e6865dcdSopenharmony_ci<pre> 73e6865dcdSopenharmony_ci <span class="c">/* Rename an object in the default drive */</span> 74e6865dcdSopenharmony_ci <em>f_rename</em>("oldname.txt", "newname.txt"); 75e6865dcdSopenharmony_ci 76e6865dcdSopenharmony_ci <span class="c">/* Rename an object in the drive 2 */</span> 77e6865dcdSopenharmony_ci <em>f_rename</em>("2:oldname.txt", "newname.txt"); 78e6865dcdSopenharmony_ci 79e6865dcdSopenharmony_ci <span class="c">/* Rename an object and move it to another directory in the drive */</span> 80e6865dcdSopenharmony_ci <em>f_rename</em>("log.txt", "old/log0001.txt"); 81e6865dcdSopenharmony_ci</pre> 82e6865dcdSopenharmony_ci</div> 83e6865dcdSopenharmony_ci 84e6865dcdSopenharmony_ci 85e6865dcdSopenharmony_ci<p class="foot"><a href="../00index_e.html">Return</a></p> 86e6865dcdSopenharmony_ci</body> 87e6865dcdSopenharmony_ci</html> 88