rename.html 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  2. <html lang="ja">
  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_j.html">
  7. <link rel="alternate" hreflang="en" title="English" href="../en/rename.html">
  8. <link rel="stylesheet" href="../css_j.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>ファイルまたはサブ ディレクトリの名前の変更または移動します。</p>
  15. <pre>
  16. FRESULT f_rename (
  17. const TCHAR* <span class="arg">old_name</span>, <span class="c">/* [IN] 古いオブジェクト名 */</span>
  18. const TCHAR* <span class="arg">new_name</span> <span class="c">/* [IN] 新しいオブジェクト名 */</span>
  19. );
  20. </pre>
  21. </div>
  22. <div class="para arg">
  23. <h4>引数</h4>
  24. <dl class="par">
  25. <dt>old_name</dt>
  26. <dd>変更対象のファイルまたはサブ ディレクトリの<a href="filename.html">パス名</a>を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。</dd>
  27. <dt>new_name</dt>
  28. <dd>新しいパス名を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。また、ドライブ番号は指定しても無視され、<tt class="arg">old_name</tt>で決められたボリューム上のオブジェクトとして扱われます。これと同じパス名(<tt class="arg">old_name</tt>は除く)のオブジェクトが存在すると、関数は<tt>FR_EXIST</tt>で失敗します。</dd>
  29. </dl>
  30. </div>
  31. <div class="para ret">
  32. <h4>戻り値</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#ex">FR_EXIST</a>,
  42. <a href="rc.html#wp">FR_WRITE_PROTECTED</a>,
  43. <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  44. <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  45. <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  46. <a href="rc.html#tm">FR_TIMEOUT</a>,
  47. <a href="rc.html#lo">FR_LOCKED</a>
  48. </p>
  49. </div>
  50. <div class="para desc">
  51. <h4>解説</h4>
  52. <p>ファイルまたはサブ ディレクトリの名前を変更します。また、同時に別のディレクトリへの移動も可能ですが、異なるドライブ間の移動はできません。開かれているオブジェクトに対する使用は不正な操作となり、<em>FAT構造が破壊される可能性</em>があります。<a href="appnote.html#dup">多重アクセス制御</a>が有効のときは安全に拒否されます。</p>
  53. </div>
  54. <div class="para comp">
  55. <h4>対応情報</h4>
  56. <p><tt>_FS_READONLY == 0</tt>で、且つ<tt>_FS_MINIMIZE == 0</tt>のときに使用可能です。</p>
  57. </div>
  58. <div class="para use">
  59. <h4>使用例</h4>
  60. <pre>
  61. <span class="c">/* デフォルト ドライブにあるオブジェクトの名前を変更 */</span>
  62. f_rename("oldname.txt", "newname.txt");
  63. <span class="c">/* ドライブ2にあるオブジェクトの名前を変更 */</span>
  64. f_rename("2:oldname.txt", "newname.txt");
  65. <span class="c">/* 名前の変更と同時に別のディレクトリに移動 */</span>
  66. f_rename("log.txt", "old/log0001.txt");
  67. </pre>
  68. </div>
  69. <p class="foot"><a href="../00index_j.html">戻る</a></p>
  70. </body>
  71. </html>