savelij13
5fa1073a5a
- Fast seek feature is also applied to f_read() and f_write(). - f_lseek() reports required table size on creating CLMP. - Extended format syntax of f_printf function. - Ignores duplicated directory separators in given path names.
131 lines
5.7 KiB
HTML
131 lines
5.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="alternate" hreflang="en" title="English" href="../en/lseek.html">
|
|
<link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
|
|
<title>FatFs - f_lseek</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="para func">
|
|
<h2>f_lseek</h2>
|
|
<p>ファイルのリード/ライト・ポインタを移動します。また、高速シーク機能使用時にはCLMT(後述)の作成にも使用します。</p>
|
|
<pre>
|
|
FRESULT f_lseek (
|
|
FIL* <em>FileObject</em>, <span class="c">/* ファイル・オブジェクト構造体へのポインタ */</span>
|
|
DWORD <em>Offset</em> <span class="c">/* 移動先オフセット */</span>
|
|
);
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="para arg">
|
|
<h4>引数</h4>
|
|
<dl class="par">
|
|
<dt>FileObject</dt>
|
|
<dd>対象となるファイル・オブジェクト構造体へのポインタを指定します。</dd>
|
|
<dt>Offset</dt>
|
|
<dd>移動先のオフセット（リード/ライト・ポインタ）値。ファイル先頭からのオフセットをバイト単位で指定します。</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para ret">
|
|
<h4>戻り値</h4>
|
|
<p>
|
|
<a href="rc.html#ok">FR_OK</a>,
|
|
<a href="rc.html#de">FR_DISK_ERR</a>,
|
|
<a href="rc.html#ie">FR_INT_ERR</a>,
|
|
<a href="rc.html#nr">FR_NOT_READY</a>,
|
|
<a href="rc.html#io">FR_INVALID_OBJECT</a>,
|
|
<a href="rc.html#tm">FR_TIMEOUT</a>,
|
|
<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
<div class="para desc">
|
|
<h4>解説</h4>
|
|
<p>ファイルのリード/ライト・ポインタ(次に読み出し・書き込みされるバイトのオフセット)を移動します。オフセットの原点はファイル先頭です。書き込みモードでファイル・サイズより大きな値を指定すると、そこまでファイル・サイズが拡張され、拡張された部分のデータは未定義となります。データを遅延無く高速に書き込みたいときは、予めこの関数で必要なサイズまでファイル・サイズを拡張しておくと良いでしょう。f_lseek関数が正常終了したあとは、リード/ライト・ポインタが正しく移動したかチェックするべきです。リード/ライト・ポインタが指定より小さいときは、次の原因が考えられます。</p>
|
|
<ul>
|
|
<li>非書き込みモードまたは高速シーク・モードのため、ファイル・サイズでクリップされた。</li>
|
|
<li>ファイル拡張中にディスクが満杯になった。</li>
|
|
</ul>
|
|
<p><tt>_USE_FASTSEEK</tt>に1が指定されていて、且つファイル・オブジェクトの<tt>cltbl</tt>メンバがNULL以外(ファイルを開いたときはNULL)のとき、高速シーク・モードになります。これはファイルのクラスタ配置情報(CLMT)をメモリ上に保持しておくことにより、FATにアクセスすることなく後方シークやロング・シークを高速に行う機能です。高速シーク・モードは、f_read/f_wtite関数にも適用されます。高速シーク・モードではf_wtite/f_lseek関数によるファイル・サイズの拡張はできません。</p>
|
|
<p>高速シーク動作を行う前に、CLMTを作成しておく必要があります。これを作成するには、まず<tt>cltbl</tt>メンバにCLMT格納バッファ(DWORD配列)へのポインタをセットします。そして、配列の先頭要素にその配列の要素数を入れ、f_lseek関数を<tt>Offset</tt>に<tt>CREATE_LINKMAP</tt>を指定して実行します。関数が成功するとCLMTが作成され、以降のf_read/f_write/f_lseek関数ではFATへのアクセスは発生しません。<tt>FR_NOT_ENOUGH_CORE</tt>で失敗したときは配列サイズが不足で、先頭要素には実際に必要となる要素数が返されます。必要な要素数は、(ファイルの分割数 + 1) * 2 です。たとえば、ファイルが5つに分断されているときに必要な要素数は、12となります。</p>
|
|
</div>
|
|
|
|
|
|
<div class="para comp">
|
|
<h4>対応情報</h4>
|
|
<p><tt>_FS_MINIMIZE < 3</tt>のとき使用可能です。</p>
|
|
</div>
|
|
|
|
|
|
<div class="para use">
|
|
<h4>使用例</h4>
|
|
<pre>
|
|
<span class="c">/* ファイルを開く */</span>
|
|
file = malloc(sizeof(FIL));
|
|
if (!file) ...
|
|
res = f_open(file, "file.dat", FA_READ|FA_WRITE);
|
|
if (res) ...
|
|
|
|
<span class="c">/* ファイル・オフセット5000へ移動 */</span>
|
|
res = f_lseek(file, 5000, 0);
|
|
|
|
<span class="c">/* ファイル終端へ移動(ファイル追記の準備) */</span>
|
|
res = f_lseek(file, f_size(file), 0);
|
|
|
|
<span class="c">/* 3000バイト進める */</span>
|
|
res = f_lseek(file, f_tell(file) + 3000, 0);
|
|
|
|
<span class="c">/* 2000バイト戻す (オーバーフローに注意) */</span>
|
|
res = f_lseek(file, f_tell(file) - 2000, 0);
|
|
</pre>
|
|
<pre>
|
|
<span class="c">/* クラスタ先行割り当て (ストリーミング・ライト時のバッファ・オーバーラン防止) */</span>
|
|
|
|
res = f_open(file, "record.wav", FA_CREATE_NEW | FA_WRITE); <span class="c">/* ファイル作成 */</span>
|
|
|
|
res = f_lseek(file, MAX_SIZE, 0); <span class="c">/* 十分なクラスタの先行割り当て */</span>
|
|
if (res || f_tell(file) != PRE_SIZE) ... <span class="c">/* 正しくファイルが拡張されたかチェック */</span>
|
|
|
|
res = f_lseek(file, DATA_START, 0); <span class="c">/* データ・ストリームの記録(アロケーションディレイ無し) */</span>
|
|
...
|
|
|
|
res = f_truncate(file); <span class="c">/* 不要領域の切り捨て */</span>
|
|
res = f_lseek(file, 0, 0); <span class="c">/* ヘッダの記録 */</span>
|
|
...
|
|
|
|
res = f_close(file);
|
|
</pre>
|
|
<pre>
|
|
<span class="c">/* 高速シーク機能を使う */</span>
|
|
|
|
DWORD lktbl[SZ_TBL]; <span class="c">/* リンク・マップ・テーブル格納バッファ */</span>
|
|
|
|
res = f_lseek(file, ofs1); <span class="c">/* 通常シーク (オープン時、file.cltbl == NULL) */</span>
|
|
|
|
file.cltbl = lktbl; <span class="c">/* 高速シーク機能の有効化 */</span>
|
|
lktbl[0] = SZ_TBL; <span class="c">/* 先頭要素に配列要素数をセット */</span>
|
|
res = f_lseek(file, CREATE_LINKMAP); <span class="c">/* CLMTの作成 */</span>
|
|
...
|
|
|
|
res = f_lseek(file, ofs2); <span class="c">/* 以降、f_read/f_write/f_lseekでFATアクセスが発生しない */</span>
|
|
</pre>
|
|
</div>
|
|
|
|
|
|
<div class="para ref">
|
|
<h4>参照</h4>
|
|
<p><tt><a href="open.html">f_open</a>, <a href="sfile.html">FIL</a></tt></p>
|
|
</div>
|
|
|
|
<p class="foot"><a href="../00index_j.html">戻る</a></p>
|
|
</body>
|
|
</html>
|