## f_lseek

ファイルのリード/ライト・ポインタを移動します。

    FRESULT f_lseek (
      FIL* FileObject,    /* ファイル・オブジェクト構造体へのポインタ */
      DWORD Offset        /* 移動先オフセット */
    );

#### 引数

FileObject
  対象となるファイル・オブジェクト構造体へのポインタを指定します。
Offset
  移動先のオフセット（リード/ライト・ポインタ）値。ファイル先頭からのオフセットをバイト単位で指定します。

#### 戻り値

FR_OK (0)
  正常終了。
FR_DISK_ERR
  ディスク・エラーによる失敗。
FR_INT_ERR
  不正なFAT構造または内部エラーによる失敗。
FR_NOT_READY
  メディアがセットされていないなど、物理ドライブが動作不能状態。
FR_INVALID_OBJECT
  無効なファイル・オブジェクト。
FR_NOT_ENOUGH_CORE
  リンク・マップ・テーブルのサイズが不足。

#### 解説

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

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

`_USE_FASTSEEK`に1が指定されていて、且つファイル・オブジェクトの`cltbl`メンバがNULL以外のとき、高速シーク・モードになります。これはファイルのクラスタ情報をアプリケーションの指定した配列に保持しておくことにより、FATにアクセスすることなく後方シークやロング・シークを高速に行う機能です。高速シーク動作を行う前には、配列を初期化しておく必要があります。必要な配列サイズ(要素数)は、(ファイルの分割数 + 1) * 2 です。たとえば、ファイルが5つに分断されているときに必要な配列サイズは、12要素となります。高速シーク使用時はファイル・サイズの拡張はできません。

#### 対応情報

`_FS_MINIMIZE < 3`のとき使用可能です。

#### 使用例

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

        /* ファイル追記の準備 (ファイル終端へ移動) */
        res = f_lseek(&file, file.fsize, 0);

        /* 3000バイト進める */
        res = f_lseek(&file, file.fptr + 3000, 0);

        /* 2000バイト戻す (オーバーフローに注意) */
        res = f_lseek(&file, file.fptr - 2000, 0);

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

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

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

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

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

        res = f_close(&file);

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

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

        res = f_lseek(&file, ofs1);            /* 通常シーク (オープン時、file.cltbl == NULL) */

        file.cltbl = lktbl;                    /* 高速シーク機能の有効化 */
        lktbl[0] = SZ_TBL;                     /* 先頭要素に配列要素数をセット */
        res = f_lseek(&file, CREATE_LINKMAP);  /* リンク・マップ・テーブルの作成 */

        res = f_lseek(&file, ofs2);            /* 高速シーク (file.cltbl != NULL) */

#### 参照

`f_open, FIL`

戻る