rename.html 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  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=ISO-8859-1">
  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. <body>
  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>
  16. FRESULT 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. <div class="para arg">
  23. <h4>Parameters</h4>
  24. <dl class="par">
  25. <dt>old_name</dt>
  26. <dd>Pointer to a null-terminated string that specifies the existing <a href="filename.html">file or sub-directory</a> to be renamed.</dd>
  27. <dt>new_name</dt>
  28. <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>
  29. </dl>
  30. </div>
  31. <div class="para ret">
  32. <h4>Return Values</h4>
  33. <p>
  34. <a href="rc.html#ok">FR_OK</a>,
  35. <a href="rc.html#de">FR_DISK_ERR</a>,
  36. <a href="rc.html#ie">FR_INT_ERR</a>,
  37. <a href="rc.html#nr">FR_NOT_READY</a>,
  38. <a href="rc.html#ok">FR_NO_FILE</a>,
  39. <a href="rc.html#np">FR_NO_PATH</a>,
  40. <a href="rc.html#in">FR_INVALID_NAME</a>,
  41. <a href="rc.html#de">FR_DENIED</a>,
  42. <a href="rc.html#ex">FR_EXIST</a>,
  43. <a href="rc.html#wp">FR_WRITE_PROTECTED</a>,
  44. <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  45. <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  46. <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  47. <a href="rc.html#tm">FR_TIMEOUT</a>,
  48. <a href="rc.html#lo">FR_LOCKED</a>,
  49. <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  50. </p>
  51. </div>
  52. <div class="para desc">
  53. <h4>Description</h4>
  54. <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>
  55. </div>
  56. <div class="para comp">
  57. <h4>QuickInfo</h4>
  58. <p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>
  59. </div>
  60. <div class="para use">
  61. <h4>Example</h4>
  62. <pre>
  63. <span class="c">/* Rename an object in the default drive */</span>
  64. f_rename("oldname.txt", "newname.txt");
  65. <span class="c">/* Rename an object in the drive 2 */</span>
  66. f_rename("2:oldname.txt", "newname.txt");
  67. <span class="c">/* Rename an object and move it to other directory in the volume */</span>
  68. f_rename("log.txt", "old/log0001.txt");
  69. </pre>
  70. </div>
  71. <p class="foot"><a href="../00index_e.html">Return</a></p>
  72. </body>
  73. </html>