savelij13
25f499b847
- Fixed f_unlink() may return FR_OK on error. - Fixed wrong cache control in f_lseek(). - Added relative path feature. - Added f_chdir(). - Added f_chdrive(). - Added proper case conversion to extended char.
88 lines
2.7 KiB
HTML
88 lines
2.7 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html lang="ja">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS">
|
|
<meta http-equiv="Content-Style-Type" content="text/css">
|
|
<link rel="up" title="FatFs" href="../00index_j.html">
|
|
<link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
|
|
<title>FatFs - f_rename</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="para">
|
|
<h2>f_rename</h2>
|
|
<p>ファイルまたはディレクトリの名前の変更または移動。</p>
|
|
<pre>
|
|
FRESULT f_rename (
|
|
const XCHAR* <em>OldName</em>, /* 古いファイルまたはディレクトリ名 */
|
|
const XCHAR* <em>NewName</em> /* 新しいファイルまたはディレクトリ名 */
|
|
);
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="para">
|
|
<h4>引数</h4>
|
|
<dl class="par">
|
|
<dt>OldName</dt>
|
|
<dd>変更対象のオブジェクト(ファイルまたはディレクトリ)への<a href="filename.html">パス名</a>の入った<tt>'\0'</tt>で終わる文字列へのポインタを指定します。</dd>
|
|
<dt>NewName</dt>
|
|
<dd>新しいファイルまたはディレクトリのフルパス名の入った<tt>'\0'</tt>で終わる文字列へのポインタを指定します。既に存在するものと同じ名前は使えません。また、ドライブ番号は指定できず、<tt>OldName</tt>で指定されたドライブ上のオブジェクトとして扱われます。<br>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>戻り値</h4>
|
|
<dl class="ret">
|
|
<dt>FR_OK (0)</dt>
|
|
<dd>正常終了。</dd>
|
|
<dt>FR_NO_FILE</dt>
|
|
<dd>OldNameのオブジェクトが見つからない。</dd>
|
|
<dt>FR_NO_PATH</dt>
|
|
<dd>パスが見つからない。</dd>
|
|
<dt>FR_INVALID_NAME</dt>
|
|
<dd>パス名が不正。</dd>
|
|
<dt>FR_INVALID_DRIVE</dt>
|
|
<dd>ドライブ番号が不正。</dd>
|
|
<dt>FR_DENIED</dt>
|
|
<dd>ドライブ容量の不足等の理由で新しい名前のオブジェクトが作れない。</dd>
|
|
<dt>FR_EXIST</dt>
|
|
<dd>NewNameと同じオブジェクトが既に存在する。</dd>
|
|
<dt>FR_NOT_READY</dt>
|
|
<dd>メディアがセットされていないなど、ディスク・ドライブが動作不能状態。</dd>
|
|
<dt>FR_WRITE_PROTECTED</dt>
|
|
<dd>メディアが書き込み禁止状態。</dd>
|
|
<dt>FR_DISK_ERR</dt>
|
|
<dd>ディスク・エラーによる失敗。</dd>
|
|
<dt>FR_INT_ERR</dt>
|
|
<dd>不正なFAT構造または内部エラーによる失敗。</dd>
|
|
<dt>FR_NOT_ENABLED</dt>
|
|
<dd>論理ドライブにワークエリアが割り当てられていない。</dd>
|
|
<dt>FR_NO_FILESYSTEM</dt>
|
|
<dd>ディスク上に有効なFATパーテーションが見つからない。</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>解説</h4>
|
|
<p>ファイルまたはディレクトリの名前を変更します。また、別のディレクトリへの移動(同じドライブ内のみ)も可能です。リード・オンリー構成および<tt>_FS_MINIMIZE >= 1</tt>ではこの関数はサポートされません。</p>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>使用例</h4>
|
|
<pre>
|
|
// ファイルまたはサブディレクトリの名前を変更する
|
|
f_rename("oldname.txt", "newname.txt");
|
|
|
|
// ファイルまたはサブディレクトリの名前を変更すると同時に別のディレクトリへ移動する
|
|
f_rename("oldname.txt", "dir1/newname.txt");
|
|
</pre>
|
|
</div>
|
|
|
|
<p class="foot"><a href="../00index_j.html">戻る</a></p>
|
|
</body>
|
|
</html>
|