fatfs/documents/doc/rename.html

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