projects / z180-stamp.git / blame
| Commit | Line | Data |
|---|---|---|
| 53668523 L |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r |
| 2 | <html lang="ja">\r | |
| 3 | <head>\r | |
| 7b78a5a2 | 4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r |
| 53668523 L |
5 | <meta http-equiv="Content-Style-Type" content="text/css">\r |
| 6 | <link rel="up" title="FatFs" href="../00index_j.html">\r | |
| 7 | <link rel="alternate" hreflang="en" title="English" href="../en/lseek.html">\r | |
| 8 | <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">\r | |
| 9 | <title>FatFs - f_lseek</title>\r | |
| 10 | </head>\r | |
| 11 | \r | |
| 12 | <body>\r | |
| 13 | \r | |
| 14 | <div class="para func">\r | |
| 15 | <h2>f_lseek</h2>\r | |
| 7b78a5a2 | 16 | <p>ファイルのリード/ライト ポインタを移動します。また、高速シーク機能使用時にはCLMT(後述)の作成にも使用します。</p>\r |
| 53668523 L |
17 | <pre>\r |
| 18 | FRESULT f_lseek (\r | |
| 70702af1 L |
19 | FIL* <span class="arg">fp</span>, <span class="c">/* [IN] ファイル オブジェクト構造体へのポインタ */</span>\r |
| 20 | FSIZE_t <span class="arg">ofs</span> <span class="c">/* [IN] 移動先オフセット */</span>\r | |
| 53668523 L |
21 | );\r |
| 22 | </pre>\r | |
| 23 | </div>\r | |
| 24 | \r | |
| 25 | <div class="para arg">\r | |
| 7b78a5a2 | 26 | <h4>引数</h4>\r |
| 53668523 L |
27 | <dl class="par">\r |
| 28 | <dt>fp</dt>\r | |
| 7b78a5a2 | 29 | <dd>対象となるファイル オブジェクト構造体へのポインタを指定します。</dd>\r |
| 53668523 | 30 | <dt>ofs</dt>\r |
| 70702af1 | 31 | <dd>移動先のオフセット(リード/ライト ポインタ)値。ファイル先頭からのオフセットをバイト単位で指定します。データ型<tt>FSIZE_t</tt>は、<tt>DWORD</tt>(32-bit)または<tt>QWORD</tt>(64-bit)のエリアスで、exFATサポートの有無により切り替わります。</dd>\r |
| 53668523 L |
32 | </dl>\r |
| 33 | </div>\r | |
| 34 | \r | |
| 35 | \r | |
| 36 | <div class="para ret">\r | |
| 7b78a5a2 | 37 | <h4>戻り値</h4>\r |
| 53668523 L |
38 | <p>\r |
| 39 | <a href="rc.html#ok">FR_OK</a>,\r | |
| 40 | <a href="rc.html#de">FR_DISK_ERR</a>,\r | |
| 41 | <a href="rc.html#ie">FR_INT_ERR</a>,\r | |
| 53668523 L |
42 | <a href="rc.html#io">FR_INVALID_OBJECT</a>,\r |
| 43 | <a href="rc.html#tm">FR_TIMEOUT</a>,\r | |
| 44 | <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>\r | |
| 45 | </p>\r | |
| 46 | </div>\r | |
| 47 | \r | |
| 48 | \r | |
| 49 | <div class="para desc">\r | |
| 7b78a5a2 | 50 | <h4>解説</h4>\r |
| 70702af1 | 51 | <p>ファイルのリード/ライト ポインタ(次に読み出し・書き込みされるバイトのオフセット)を移動します。オフセットの原点はファイル先頭です。書き込みモードでファイル サイズより大きな値を指定すると、そこまでファイル サイズが拡張され、拡張された部分のデータは未定義となります。データを遅延無く高速に書き込みたいときは、予めこの関数で必要なサイズまでファイル サイズを拡張しておくと良いでしょう。ファイルに連続したデータ領域を割り当てる必要があるときは、<tt>f_expand</tt>関数を使用してください。<tt>f_lseek</tt>関数が正常終了したあとは、リード/ライト ポインタが正しく移動したかチェックするべきです。リード/ライト ポインタが指定より小さいときは、次の原因が考えられます。</p>\r |
| 53668523 | 52 | <ul>\r |
| 7b78a5a2 L |
53 | <li>非書き込みモードまたは高速シーク モードのため、ファイル サイズでクリップされた。</li>\r |
| 54 | <li>ファイル拡張中にディスクが満杯になった。</li>\r | |
| 53668523 | 55 | </ul>\r |
| 70702af1 L |
56 | <p>高速シーク モードは、ファイルのクラスタ配置情報(CLMT)をメモリ上に保持しておくことにより、FATにアクセスすることなく後方シークやロング シークを高速に行う機能で、シーク動作のほか<tt>f_read/f_wtite</tt>関数の動作にも適用されます。ファイルが高速シーク モードの間は<tt>f_wtite/f_lseek</tt>関数によるファイル サイズの拡張はできません。</p>\r |
| 57 | <p>高速シーク モードは、ファイル オブジェクトのメンバ<tt>cltbl</tt>(<tt>f_open</tt>関数でNULLになる)にNULL以外を設定したとき有効になるので、まず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へのアクセスは発生しません。CLMTの先頭要素には実際に使用した(または必要となる)要素数が返されます。使用される要素数は、(ファイルの分割数 + 1) * 2 です。たとえば、ファイルが5つのフラグメントに分断されているときは、12要素が使用されます。<tt>FR_NOT_ENOUGH_CORE</tt>で失敗したときは、配列サイズが不足です。</p>\r | |
| 53668523 L |
58 | </div>\r |
| 59 | \r | |
| 60 | \r | |
| 61 | <div class="para comp">\r | |
| 7b78a5a2 | 62 | <h4>対応情報</h4>\r |
| 70702af1 | 63 | <p><tt>_FS_MINIMIZE < 3</tt>のとき使用可能です。高速シーク モードを利用するときは、<tt><a href="config.html#use_fastseek">_USE_FASTSEEK</a> == 1</tt>である必要があります。</p>\r |
| 53668523 L |
64 | </div>\r |
| 65 | \r | |
| 66 | \r | |
| 67 | <div class="para use">\r | |
| 7b78a5a2 | 68 | <h4>使用例</h4>\r |
| 53668523 | 69 | <pre>\r |
| 7b78a5a2 | 70 | <span class="c">/* ファイルを開く */</span>\r |
| 53668523 L |
71 | fp = malloc(sizeof (FIL));\r |
| 72 | res = f_open(fp, "file.dat", FA_READ|FA_WRITE);\r | |
| 73 | if (res) ...\r | |
| 74 | \r | |
| 7b78a5a2 | 75 | <span class="c">/* ファイル オフセット5000へ移動 */</span>\r |
| 53668523 L |
76 | res = f_lseek(fp, 5000);\r |
| 77 | \r | |
| 7b78a5a2 | 78 | <span class="c">/* ファイル終端へ移動(ファイル追記の準備) */</span>\r |
| 53668523 L |
79 | res = f_lseek(fp, f_size(fp));\r |
| 80 | \r | |
| 7b78a5a2 | 81 | <span class="c">/* 3000バイト進める */</span>\r |
| 53668523 L |
82 | res = f_lseek(fp, f_tell(fp) + 3000);\r |
| 83 | \r | |
| 7b78a5a2 | 84 | <span class="c">/* 2000バイト戻す (ラップアラウンドに注意) */</span>\r |
| 53668523 L |
85 | res = f_lseek(fp, f_tell(fp) - 2000);\r |
| 86 | </pre>\r | |
| 87 | <pre>\r | |
| 7b78a5a2 | 88 | <span class="c">/* クラスタ先行割り当て (ストリーミング ライト時のバッファ オーバーラン防止) */</span>\r |
| 53668523 | 89 | \r |
| 7b78a5a2 | 90 | res = f_open(fp, "record.wav", FA_CREATE_NEW | FA_WRITE); <span class="c">/* ファイル作成 */</span>\r |
| 53668523 | 91 | \r |
| 7b78a5a2 L |
92 | res = f_lseek(fp, MAX_SIZE); <span class="c">/* 十分なクラスタの先行割り当て */</span>\r |
| 93 | if (res || f_tell(fp) != PRE_SIZE) ... <span class="c">/* 正しくファイルが拡張されたかチェック */</span>\r | |
| 53668523 | 94 | \r |
| 7b78a5a2 | 95 | res = f_lseek(fp, DATA_START); <span class="c">/* データ ストリームの記録(アロケーションディレイ無し) */</span>\r |
| 53668523 L |
96 | ...\r |
| 97 | \r | |
| 7b78a5a2 L |
98 | res = f_truncate(fp); <span class="c">/* 不要領域の切り捨て */</span>\r |
| 99 | res = f_lseek(fp, 0); <span class="c">/* ヘッダの記録 */</span>\r | |
| 53668523 L |
100 | ...\r |
| 101 | \r | |
| 102 | res = f_close(fp);\r | |
| 103 | </pre>\r | |
| 104 | <pre>\r | |
| 7b78a5a2 | 105 | <span class="c">/* 高速シーク機能を使う */</span>\r |
| 53668523 | 106 | \r |
| 7b78a5a2 | 107 | DWORD clmt[SZ_TBL]; <span class="c">/* リンク マップ テーブル格納バッファ */</span>\r |
| 53668523 | 108 | \r |
| 70702af1 L |
109 | res = f_open(fp, fname, FA_READ | FA_WRITE); <span class="c">/* ファイルを開く */</span>\r |
| 110 | \r | |
| 7b78a5a2 | 111 | res = f_lseek(fp, ofs1); <span class="c">/* 通常シーク (オープン時、cltblはNULLに初期化される) */</span>\r |
| 53668523 | 112 | \r |
| 7b78a5a2 L |
113 | fp->cltbl = clmt; <span class="c">/* 高速シーク機能の有効化 */</span>\r |
| 114 | clmt[0] = SZ_TBL; <span class="c">/* 先頭要素に配列要素数をセット */</span>\r | |
| 115 | res = f_lseek(fp, CREATE_LINKMAP); <span class="c">/* CLMTの作成 */</span>\r | |
| 53668523 L |
116 | ...\r |
| 117 | \r | |
| 7b78a5a2 | 118 | res = f_lseek(fp, ofs2); <span class="c">/* 以降、f_read/f_write/f_lseekでFATアクセスは発生しない */</span>\r |
| 53668523 L |
119 | </pre>\r |
| 120 | </div>\r | |
| 121 | \r | |
| 122 | \r | |
| 123 | <div class="para ref">\r | |
| 7b78a5a2 | 124 | <h4>参照</h4>\r |
| 70702af1 | 125 | <p><tt><a href="open.html">f_open</a>, <a href="truncate.html">f_truncate</a>, <a href="expand.html">f_expand</a>, <a href="sfile.html">FIL</a></tt></p>\r |
| 53668523 L |
126 | </div>\r |
| 127 | \r | |
| 7b78a5a2 | 128 | <p class="foot"><a href="../00index_j.html">戻る</a></p>\r |
| 53668523 L |
129 | </body>\r |
| 130 | </html>\r |