1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <meta http-equiv=
"Content-Type" content=
"text/html; charset=utf-8">
5 <meta http-equiv=
"Content-Style-Type" content=
"text/css">
6 <link rel=
"up" title=
"FatFs" href=
"../00index_j.html">
7 <link rel=
"alternate" hreflang=
"en" title=
"English" href=
"../en/lseek.html">
8 <link rel=
"stylesheet" href=
"../css_j.css" type=
"text/css" media=
"screen" title=
"ELM Default">
9 <title>FatFs - f_lseek
</title>
14 <div class=
"para func">
16 <p>ファイルのリード/ライト ポインタを移動します。また、高速シーク機能使用時にはCLMT(後述)の作成にも使用します。
</p>
19 FIL*
<span class=
"arg">fp
</span>,
<span class=
"c">/* [IN] ファイル オブジェクト構造体へのポインタ */
</span>
20 DWORD
<span class=
"arg">ofs
</span> <span class=
"c">/* [IN] 移動先オフセット */
</span>
25 <div class=
"para arg">
29 <dd>対象となるファイル オブジェクト構造体へのポインタを指定します。
</dd>
31 <dd>移動先のオフセット(リード/ライト ポインタ)値。ファイル先頭からのオフセットをバイト単位で指定します。
</dd>
36 <div class=
"para ret">
39 <a href=
"rc.html#ok">FR_OK
</a>,
40 <a href=
"rc.html#de">FR_DISK_ERR
</a>,
41 <a href=
"rc.html#ie">FR_INT_ERR
</a>,
42 <a href=
"rc.html#nr">FR_NOT_READY
</a>,
43 <a href=
"rc.html#io">FR_INVALID_OBJECT
</a>,
44 <a href=
"rc.html#tm">FR_TIMEOUT
</a>,
45 <a href=
"rc.html#nc">FR_NOT_ENOUGH_CORE
</a>
50 <div class=
"para desc">
52 <p>ファイルのリード/ライト ポインタ(次に読み出し・書き込みされるバイトのオフセット)を移動します。オフセットの原点はファイル先頭です。書き込みモードでファイル サイズより大きな値を指定すると、そこまでファイル サイズが拡張され、拡張された部分のデータは未定義となります。データを遅延無く高速に書き込みたいときは、予めこの関数で必要なサイズまでファイル サイズを拡張しておくと良いでしょう。
<tt>f_lseek()
</tt>が正常終了したあとは、リード/ライト ポインタが正しく移動したかチェックするべきです。リード/ライト ポインタが指定より小さいときは、次の原因が考えられます。
</p>
54 <li>非書き込みモードまたは高速シーク モードのため、ファイル サイズでクリップされた。
</li>
55 <li>ファイル拡張中にディスクが満杯になった。
</li>
57 <p><tt>_USE_FASTSEEK
</tt>が
1で、且つファイル オブジェクトの
<tt>cltbl
</tt>メンバがNULL以外(
<tt>f_open()
</tt>でNULLに設定される)のとき、高速シーク モードになります。これはファイルのクラスタ配置情報(CLMT)をメモリ上に保持しておくことにより、FATにアクセスすることなく後方シークやロング シークを高速に行う機能です。高速シーク モードは、
<tt>f_read()/f_wtite()
</tt>の動作にも適用されます。高速シーク モードでは
<tt>f_wtite()/f_lseek()
</tt>によるファイル サイズの拡張はできません。
</p>
58 <p>高速シーク動作を行う前に、CLMTを作成しておく必要があります。これを作成するには、まずCLMT格納バッファ(
<tt>DWORD
</tt>型配列)を準備し、
<tt>cltbl
</tt>メンバにそのポインタをセットします。そして、配列の先頭要素にその配列のサイズ(要素数)を入れ、
<tt>f_lseek()
</tt>を
<tt class=
"arg">ofs
</tt>に
<tt>CREATE_LINKMAP
</tt>を指定して呼び出します。関数が成功するとCLMTが作成され、以降の
<tt>f_read()/f_write()/f_lseek()
</tt>ではFATへのアクセスは発生しません。
<tt>FR_NOT_ENOUGH_CORE
</tt>で失敗したときは配列サイズが不足で、先頭要素には実際に必要となる要素数が返されます。必要な要素数は、(ファイルの分割数 +
1) *
2 です。たとえば、ファイルが
5つのフラグメントに分断されているときに必要な要素数は、
12となります。
</p>
62 <div class=
"para comp">
64 <p><tt>_FS_MINIMIZE
< 3</tt>のとき使用可能です。
</p>
68 <div class=
"para use">
71 <span class=
"c">/* ファイルを開く */
</span>
72 fp = malloc(sizeof (FIL));
73 res = f_open(fp,
"file.dat", FA_READ|FA_WRITE);
76 <span class=
"c">/* ファイル オフセット
5000へ移動 */
</span>
77 res = f_lseek(fp,
5000);
79 <span class=
"c">/* ファイル終端へ移動(ファイル追記の準備) */
</span>
80 res = f_lseek(fp, f_size(fp));
82 <span class=
"c">/*
3000バイト進める */
</span>
83 res = f_lseek(fp, f_tell(fp) +
3000);
85 <span class=
"c">/*
2000バイト戻す (ラップアラウンドに注意) */
</span>
86 res = f_lseek(fp, f_tell(fp) -
2000);
89 <span class=
"c">/* クラスタ先行割り当て (ストリーミング ライト時のバッファ オーバーラン防止) */
</span>
91 res = f_open(fp,
"record.wav", FA_CREATE_NEW | FA_WRITE);
<span class=
"c">/* ファイル作成 */
</span>
93 res = f_lseek(fp, MAX_SIZE);
<span class=
"c">/* 十分なクラスタの先行割り当て */
</span>
94 if (res || f_tell(fp) != PRE_SIZE) ...
<span class=
"c">/* 正しくファイルが拡張されたかチェック */
</span>
96 res = f_lseek(fp, DATA_START);
<span class=
"c">/* データ ストリームの記録(アロケーションディレイ無し) */
</span>
99 res = f_truncate(fp);
<span class=
"c">/* 不要領域の切り捨て */
</span>
100 res = f_lseek(fp,
0);
<span class=
"c">/* ヘッダの記録 */
</span>
106 <span class=
"c">/* 高速シーク機能を使う */
</span>
108 DWORD clmt[SZ_TBL];
<span class=
"c">/* リンク マップ テーブル格納バッファ */
</span>
110 res = f_lseek(fp, ofs1);
<span class=
"c">/* 通常シーク (オープン時、cltblはNULLに初期化される) */
</span>
112 fp-
>cltbl = clmt;
<span class=
"c">/* 高速シーク機能の有効化 */
</span>
113 clmt[
0] = SZ_TBL;
<span class=
"c">/* 先頭要素に配列要素数をセット */
</span>
114 res = f_lseek(fp, CREATE_LINKMAP);
<span class=
"c">/* CLMTの作成 */
</span>
117 res = f_lseek(fp, ofs2);
<span class=
"c">/* 以降、f_read/f_write/f_lseekでFATアクセスは発生しない */
</span>
122 <div class=
"para ref">
124 <p><tt><a href=
"open.html">f_open
</a>,
<a href=
"sfile.html">FIL
</a></tt></p>
127 <p class=
"foot"><a href=
"../00index_j.html">戻る
</a></p>