## f_lseek

ファイルのリード/ライト ポインタを移動します。また、高速シーク機能使用時にはCLMT(後述)の作成にも使用します。

    FRESULT f_lseek (
      FIL* fp,      /* [IN] ファイル オブジェクト構造体へのポインタ */
      FSIZE_t ofs   /* [IN] 移動先オフセット */
    );

#### 引数

fp
  対象となるファイル オブジェクト構造体へのポインタを指定します。
ofs
  移動先のオフセット(リード/ライト ポインタ)値。ファイル先頭からのオフセットをバイト単位で指定します。データ型`FSIZE_t`は、`DWORD`(32-bit)または`QWORD`(64-bit)のエリアスで、exFATサポートの有無により切り替わります。

#### 戻り値

FR_OK, FR_DISK_ERR, FR_INT_ERR, FR_INVALID_OBJECT, FR_TIMEOUT, FR_NOT_ENOUGH_CORE

#### 解説

ファイルのリード/ライト ポインタ(次に読み出し・書き込みされるバイトのオフセット)を移動します。オフセットの原点はファイル先頭です。書き込みモードでファイル サイズより大きな値を指定すると、そこまでファイル サイズが拡張され、拡張された部分のデータは未定義となります。データを遅延無く高速に書き込みたいときは、予めこの関数で必要なサイズまでファイル サイズを拡張しておくと良いでしょう。ファイルに連続したデータ領域を割り当てる必要があるときは、`f_expand`関数を使用してください。`f_lseek`関数が正常終了したあとは、リード/ライト ポインタが正しく移動したかチェックするべきです。リード/ライト ポインタが指定より小さいときは、次の原因が考えられます。

- 非書き込みモードまたは高速シーク モードのため、ファイル サイズでクリップされた。
- ファイル拡張中にディスクが満杯になった。

高速シーク モードは、ファイルのクラスタ配置情報(CLMT)をメモリ上に保持しておくことにより、FATにアクセスすることなく後方シークやロング シークを高速に行う機能で、シーク動作のほか`f_read/f_wtite`関数の動作にも適用されます。ファイルが高速シーク モードの間は`f_wtite/f_lseek`関数によるファイル サイズの拡張はできません。

高速シーク モードは、ファイル オブジェクトのメンバ`cltbl`(`f_open`関数でNULLになる)にNULL以外を設定したとき有効になるので、まずCLMTを作成しておく必要があります。これを作成するには、まずCLMT格納バッファ(`DWORD`型配列)を準備し、`cltbl`にそのポインタをセットします。そして、配列の先頭要素にその配列のサイズ(要素数)を入れ、`f_lseek`関数を`ofs`に`CREATE_LINKMAP`を指定して呼び出します。関数が成功するとCLMTが作成され、以降の`f_read/f_write/f_lseek`関数ではFATへのアクセスは発生しません。CLMTの先頭要素には実際に使用した(または必要となる)要素数が返されます。使用される要素数は、(ファイルの分割数 + 1) * 2 です。たとえば、ファイルが5つのフラグメントに分断されているときは、12要素が使用されます。`FR_NOT_ENOUGH_CORE`で失敗したときは、配列サイズが不足です。

#### 対応情報

`_FS_MINIMIZE < 3`のとき使用可能です。高速シーク モードを利用するときは、`_USE_FASTSEEK == 1`である必要があります。

#### 使用例

        /* ファイルを開く */
        fp = malloc(sizeof (FIL));
        res = f_open(fp, "file.dat", FA_READ|FA_WRITE);
        if (res) ...

        /* ファイル オフセット5000へ移動 */
        res = f_lseek(fp, 5000);

        /* ファイル終端へ移動(ファイル追記の準備) */
        res = f_lseek(fp, f_size(fp));

        /* 3000バイト進める */
        res = f_lseek(fp, f_tell(fp) + 3000);

        /* 2000バイト戻す (ラップアラウンドに注意) */
        res = f_lseek(fp, f_tell(fp) - 2000);

    /* クラスタ先行割り当て (ストリーミング ライト時のバッファ オーバーラン防止) */

        res = f_open(fp, "record.wav", FA_CREATE_NEW | FA_WRITE);    /* ファイル作成 */

        res = f_lseek(fp, MAX_SIZE);             /* 十分なクラスタの先行割り当て */
        if (res || f_tell(fp) != PRE_SIZE) ...   /* 正しくファイルが拡張されたかチェック */

        res = f_lseek(fp, DATA_START);           /* データ ストリームの記録(アロケーションディレイ無し) */
        ...

        res = f_truncate(fp);                    /* 不要領域の切り捨て */
        res = f_lseek(fp, 0);                    /* ヘッダの記録 */
        ...

        res = f_close(fp);

    /* 高速シーク機能を使う */

        DWORD clmt[SZ_TBL];                    /* リンク マップ テーブル格納バッファ */

        res = f_open(fp, fname, FA_READ | FA_WRITE);   /* ファイルを開く */

        res = f_lseek(fp, ofs1);               /* 通常シーク (オープン時、cltblはNULLに初期化される) */

        fp->cltbl = clmt;                      /* 高速シーク機能の有効化 */
        clmt[0] = SZ_TBL;                      /* 先頭要素に配列要素数をセット */
        res = f_lseek(fp, CREATE_LINKMAP);     /* CLMTの作成 */
        ...

        res = f_lseek(fp, ofs2);               /* 以降、f_read/f_write/f_lseekでFATアクセスは発生しない */

#### 参照

`f_open, f_truncate, f_expand, FIL`

戻る