f_lseek

ファイルのR/Wポインタを移動します。

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

引数

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

戻り値

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

解説

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

対応情報

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

使用例

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

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

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

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

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

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

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

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

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

    res = f_close(&file);

参照

f_open, FIL

戻る