savelij13
f76dc3a97f
- Improved cluster scan algolithm to write files fast. - Fixed f_mkdir() creates incorrect directory on FAT32.
85 lines
2.5 KiB
HTML
85 lines
2.5 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 char* <em>OldName</em>, // 古いファイルまたはディレクトリの文字列へのポインタ
|
|
const char* <em>NewName</em> // 新しいファイルまたはディレクトリの文字列へのポインタ
|
|
);
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="para">
|
|
<h4>パラメータ</h4>
|
|
<dl class="par">
|
|
<dt>OldName</dt>
|
|
<dd>変更対象のファイルまたはディレクトリのフルパス名の入った<tt>'\0'</tt>で終わる文字列へのポインタを指定します。</dd>
|
|
<dt>NewName</dt>
|
|
<dd>新しいファイルまたはディレクトリのフルパス名の入った<tt>'\0'</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>ファイルが見つからない。</dd>
|
|
<dt>FR_NO_PATH</dt>
|
|
<dd>パスが見つからない。</dd>
|
|
<dt>FR_INVALID_NAME</dt>
|
|
<dd>パス名が不正。</dd>
|
|
<dt>FR_DENIED</dt>
|
|
<dd>新しい名前が作れない。</dd>
|
|
<dt>FR_NOT_READY</dt>
|
|
<dd>メディアがセットされていないなど、ディスクドライブが動作不能状態。</dd>
|
|
<dt>FR_WRITE_PROTECTED</dt>
|
|
<dd>メディアが書き込み禁止状態。</dd>
|
|
<dt>FR_RW_ERROR</dt>
|
|
<dd>ディスクアクセスでエラーが発生した。</dd>
|
|
<dt>FR_INCORRECT_DISK_CHANGE</dt>
|
|
<dd>不正なメディアの取り外しがあった。ファイルを開いたままのメディア交換など。</dd>
|
|
<dt>FR_NOT_ENABLED</dt>
|
|
<dd>FatFsモジュールが停止状態。</dd>
|
|
<dt>FR_NO_FILESYSTEM</dt>
|
|
<dd>ディスク上に有効なFATパーテーションが見つからない。</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>解説</h4>
|
|
<p>ファイルまたはディレクトリの名前を変更します。別のディレクトリへの移動も可能です。リードオンリー構成および<tt>_FS_MINIMIZE >= 1</tt>ではこの関数はサポートされません。</p>
|
|
<p>※現リビジョンでは、ディレクトリを別のディレクトリに移動するとファイルシステムが壊れます。</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>
|