projects / z180-stamp.git / blame
| Commit | Line | Data |
|---|---|---|
| 53668523 L |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r |
| 2 | <html lang="ja">\r | |
| 3 | <head>\r | |
| 7b78a5a2 | 4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r |
| 53668523 L |
5 | <meta http-equiv="Content-Style-Type" content="text/css">\r |
| 6 | <link rel="up" title="FatFs" href="../00index_j.html">\r | |
| 7 | <link rel="alternate" hreflang="en" title="English" href="../en/rename.html">\r | |
| 8 | <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">\r | |
| 9 | <title>FatFs - f_rename</title>\r | |
| 10 | </head>\r | |
| 11 | \r | |
| 12 | <body>\r | |
| 13 | \r | |
| 14 | <div class="para func">\r | |
| 15 | <h2>f_rename</h2>\r | |
| 7b78a5a2 | 16 | <p>ファイルまたはサブ ディレクトリの名前の変更または移動します。</p>\r |
| 53668523 L |
17 | <pre>\r |
| 18 | FRESULT f_rename (\r | |
| 7b78a5a2 L |
19 | const TCHAR* <span class="arg">old_name</span>, <span class="c">/* [IN] 古いオブジェクト名 */</span>\r |
| 20 | const TCHAR* <span class="arg">new_name</span> <span class="c">/* [IN] 新しいオブジェクト名 */</span>\r | |
| 53668523 L |
21 | );\r |
| 22 | </pre>\r | |
| 23 | </div>\r | |
| 24 | \r | |
| 25 | <div class="para arg">\r | |
| 7b78a5a2 | 26 | <h4>引数</h4>\r |
| 53668523 L |
27 | <dl class="par">\r |
| 28 | <dt>old_name</dt>\r | |
| 7b78a5a2 | 29 | <dd>変更対象のファイルまたはサブ ディレクトリの<a href="filename.html">パス名</a>を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。</dd>\r |
| 53668523 | 30 | <dt>new_name</dt>\r |
| 70702af1 | 31 | <dd>新しいパス名を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。また、ドライブ番号は指定しても無視され、<tt class="arg">old_name</tt>で決められたボリューム上のオブジェクトとして扱われます。これと同じパス名(<tt class="arg">old_name</tt>は除く)のオブジェクトが存在すると、関数は<tt>FR_EXIST</tt>で失敗します。</dd>\r |
| 53668523 L |
32 | </dl>\r |
| 33 | </div>\r | |
| 34 | \r | |
| 35 | \r | |
| 36 | <div class="para ret">\r | |
| 7b78a5a2 | 37 | <h4>戻り値</h4>\r |
| 53668523 L |
38 | <p>\r |
| 39 | <a href="rc.html#ok">FR_OK</a>,\r | |
| 40 | <a href="rc.html#de">FR_DISK_ERR</a>,\r | |
| 41 | <a href="rc.html#ie">FR_INT_ERR</a>,\r | |
| 42 | <a href="rc.html#nr">FR_NOT_READY</a>,\r | |
| 43 | <a href="rc.html#ok">FR_NO_FILE</a>,\r | |
| 44 | <a href="rc.html#np">FR_NO_PATH</a>,\r | |
| 45 | <a href="rc.html#in">FR_INVALID_NAME</a>,\r | |
| 46 | <a href="rc.html#ex">FR_EXIST</a>,\r | |
| 47 | <a href="rc.html#wp">FR_WRITE_PROTECTED</a>,\r | |
| 48 | <a href="rc.html#id">FR_INVALID_DRIVE</a>,\r | |
| 49 | <a href="rc.html#ne">FR_NOT_ENABLED</a>,\r | |
| 50 | <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,\r | |
| 51 | <a href="rc.html#tm">FR_TIMEOUT</a>,\r | |
| 52 | <a href="rc.html#lo">FR_LOCKED</a>\r | |
| 53 | </p>\r | |
| 54 | </div>\r | |
| 55 | \r | |
| 56 | \r | |
| 57 | <div class="para desc">\r | |
| 7b78a5a2 | 58 | <h4>解説</h4>\r |
| 70702af1 | 59 | <p>ファイルまたはサブ ディレクトリの名前を変更します。また、同時に別のディレクトリへの移動も可能ですが、異なるドライブ間の移動はできません。開かれているオブジェクトに対する使用は不正な操作となり、<em>FAT構造が破壊される可能性</em>があります。<a href="appnote.html#dup">多重アクセス制御</a>が有効のときは安全に拒否されます。</p>\r |
| 53668523 L |
60 | </div>\r |
| 61 | \r | |
| 62 | \r | |
| 63 | <div class="para comp">\r | |
| 7b78a5a2 L |
64 | <h4>対応情報</h4>\r |
| 65 | <p><tt>_FS_READONLY == 0</tt>で、且つ<tt>_FS_MINIMIZE == 0</tt>のときに使用可能です。</p>\r | |
| 53668523 L |
66 | </div>\r |
| 67 | \r | |
| 68 | \r | |
| 69 | <div class="para use">\r | |
| 7b78a5a2 | 70 | <h4>使用例</h4>\r |
| 53668523 | 71 | <pre>\r |
| 70702af1 | 72 | <span class="c">/* デフォルト ドライブにあるオブジェクトの名前を変更 */</span>\r |
| 53668523 L |
73 | f_rename("oldname.txt", "newname.txt");\r |
| 74 | \r | |
| 70702af1 L |
75 | <span class="c">/* ドライブ2にあるオブジェクトの名前を変更 */</span>\r |
| 76 | f_rename("2:oldname.txt", "newname.txt");\r | |
| 77 | \r | |
| 78 | <span class="c">/* 名前の変更と同時に別のディレクトリに移動 */</span>\r | |
| 79 | f_rename("log.txt", "old/log0001.txt");\r | |
| 53668523 L |
80 | </pre>\r |
| 81 | </div>\r | |
| 82 | \r | |
| 7b78a5a2 | 83 | <p class="foot"><a href="../00index_j.html">戻る</a></p>\r |
| 53668523 L |
84 | </body>\r |
| 85 | </html>\r |