savelij13
625f3adcbb
- Added f_getcwd(). (_FS_RPATH = 2) - Added sector erase feature. (_USE_ERASE) - Moved file lock semaphore table from fs object to the bss. - Fixed a wrong directory entry is created on non-LFN cfg when the given name contains ';'. - Fixed f_mkfs() creates wrong FAT32 volume.
97 lines
2.9 KiB
HTML
97 lines
2.9 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="alternate" hreflang="en" title="English" href="../en/rename.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 TCHAR* <em>OldName</em>, <span>/* 古いオブジェクト名 */</span>
|
|
const TCHAR* <em>NewName</em> <span>/* 新しいオブジェクト名 */</span>
|
|
);
|
|
</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>
|
|
<dt>FR_LOCKED</dt>
|
|
<dd>ファイル共有機能(_FS_SHARE)によるアクセス拒否。</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>解説</h4>
|
|
<p>オブジェクトの名前を変更します。また、別のディレクトリへの移動も可能です。<em>開かれているオブジェクトに対して使用してはなりません</em>。</p>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>対応情報</h4>
|
|
<p><tt>_FS_READONLY == 0</tt>で、且つ<tt>_FS_MINIMIZE == 0</tt>のときに使用可能です。</p>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>使用例</h4>
|
|
<pre>
|
|
<span>/* ファイルまたはサブディレクトリの名前を変更する */</span>
|
|
f_rename("oldname.txt", "newname.txt");
|
|
|
|
<span>/* ファイルまたはサブディレクトリの名前の変更と別のディレクトリへの移動 */</span>
|
|
f_rename("oldname.txt", "dir1/newname.txt");
|
|
</pre>
|
|
</div>
|
|
|
|
<p class="foot"><a href="../00index_j.html">戻る</a></p>
|
|
</body>
|
|
</html>
|