f_lseek

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

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

引数

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

戻り値

FR_OK, FR_DISK_ERR, FR_INT_ERR, FR_NOT_READY, FR_INVALID_OBJECT, FR_TIMEOUT, FR_NOT_ENOUGH_CORE

解説

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

_USE_FASTSEEKに1が指定されていて、且つファイル・オブジェクトのcltblメンバがNULL以外(ファイルを開いたときはNULL)のとき、高速シーク・モードになります。これはファイルのクラスタ配置情報(CLMT)をメモリ上に保持しておくことにより、FATにアクセスすることなく後方シークやロング・シークを高速に行う機能です。高速シーク・モードは、f_read/f_wtite関数にも適用されます。高速シーク・モードではf_wtite/f_lseek関数によるファイル・サイズの拡張はできません。

高速シーク動作を行う前に、CLMTを作成しておく必要があります。これを作成するには、まずcltblメンバにCLMT格納バッファ(DWORD配列)へのポインタをセットします。そして、配列の先頭要素にその配列の要素数を入れ、f_lseek関数をOffsetにCREATE_LINKMAPを指定して実行します。関数が成功するとCLMTが作成され、以降のf_read/f_write/f_lseek関数ではFATへのアクセスは発生しません。FR_NOT_ENOUGH_COREで失敗したときは配列サイズが不足で、先頭要素には実際に必要となる要素数が返されます。必要な要素数は、(ファイルの分割数 + 1) * 2 です。たとえば、ファイルが5つに分断されているときに必要な要素数は、12となります。

対応情報

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

使用例

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

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

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

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

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

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

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

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

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

    res = f_truncate(file);                  /* 不要領域の切り捨て */
    res = f_lseek(file, 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);   /* CLMTの作成 */
    ...

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

参照

f_open, FIL

戻る