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 | |
| 7b78a5a2 L |
19 | FIL* <span class="arg">fp</span>, <span class="c">/* [IN] ファイル オブジェクト構造体へのポインタ */</span>\r |
| 20 | DWORD <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 |
| 7b78a5a2 | 31 | <dd>移動先のオフセット(リード/ライト ポインタ)値。ファイル先頭からのオフセットをバイト単位で指定します。</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 | |
| 42 | <a href="rc.html#nr">FR_NOT_READY</a>,\r | |
| 43 | <a href="rc.html#io">FR_INVALID_OBJECT</a>,\r | |
| 44 | <a href="rc.html#tm">FR_TIMEOUT</a>,\r | |
| 45 | <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>\r | |
| 46 | </p>\r | |
| 47 | </div>\r | |
| 48 | \r | |
| 49 | \r | |
| 50 | <div class="para desc">\r | |
| 7b78a5a2 L |
51 | <h4>解説</h4>\r |
| 52 | <p>ファイルのリード/ライト ポインタ(次に読み出し・書き込みされるバイトのオフセット)を移動します。オフセットの原点はファイル先頭です。書き込みモードでファイル サイズより大きな値を指定すると、そこまでファイル サイズが拡張され、拡張された部分のデータは未定義となります。データを遅延無く高速に書き込みたいときは、予めこの関数で必要なサイズまでファイル サイズを拡張しておくと良いでしょう。<tt>f_lseek()</tt>が正常終了したあとは、リード/ライト ポインタが正しく移動したかチェックするべきです。リード/ライト ポインタが指定より小さいときは、次の原因が考えられます。</p>\r | |
| 53668523 | 53 | <ul>\r |
| 7b78a5a2 L |
54 | <li>非書き込みモードまたは高速シーク モードのため、ファイル サイズでクリップされた。</li>\r |
| 55 | <li>ファイル拡張中にディスクが満杯になった。</li>\r | |
| 53668523 | 56 | </ul>\r |
| 7b78a5a2 L |
57 | <p><tt>_USE_FASTSEEK</tt>が1で、且つファイル オブジェクトの<tt>cltbl</tt>メンバがNULL以外(<tt>f_open()</tt>でNULLに設定される)のとき、高速シーク モードになります。これはファイルのクラスタ配置情報(CLMT)をメモリ上に保持しておくことにより、FATにアクセスすることなく後方シークやロング シークを高速に行う機能です。高速シーク モードは、<tt>f_read()/f_wtite()</tt>の動作にも適用されます。高速シーク モードでは<tt>f_wtite()/f_lseek()</tt>によるファイル サイズの拡張はできません。</p>\r |
| 58 | <p>高速シーク動作を行う前に、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へのアクセスは発生しません。<tt>FR_NOT_ENOUGH_CORE</tt>で失敗したときは配列サイズが不足で、先頭要素には実際に必要となる要素数が返されます。必要な要素数は、(ファイルの分割数 + 1) * 2 です。たとえば、ファイルが5つのフラグメントに分断されているときに必要な要素数は、12となります。</p>\r | |
| 53668523 L |
59 | </div>\r |
| 60 | \r | |
| 61 | \r | |
| 62 | <div class="para comp">\r | |
| 7b78a5a2 L |
63 | <h4>対応情報</h4>\r |
| 64 | <p><tt>_FS_MINIMIZE < 3</tt>のとき使用可能です。</p>\r | |
| 53668523 L |
65 | </div>\r |
| 66 | \r | |
| 67 | \r | |
| 68 | <div class="para use">\r | |
| 7b78a5a2 | 69 | <h4>使用例</h4>\r |
| 53668523 | 70 | <pre>\r |
| 7b78a5a2 | 71 | <span class="c">/* ファイルを開く */</span>\r |
| 53668523 L |
72 | fp = malloc(sizeof (FIL));\r |
| 73 | res = f_open(fp, "file.dat", FA_READ|FA_WRITE);\r | |
| 74 | if (res) ...\r | |
| 75 | \r | |
| 7b78a5a2 | 76 | <span class="c">/* ファイル オフセット5000へ移動 */</span>\r |
| 53668523 L |
77 | res = f_lseek(fp, 5000);\r |
| 78 | \r | |
| 7b78a5a2 | 79 | <span class="c">/* ファイル終端へ移動(ファイル追記の準備) */</span>\r |
| 53668523 L |
80 | res = f_lseek(fp, f_size(fp));\r |
| 81 | \r | |
| 7b78a5a2 | 82 | <span class="c">/* 3000バイト進める */</span>\r |
| 53668523 L |
83 | res = f_lseek(fp, f_tell(fp) + 3000);\r |
| 84 | \r | |
| 7b78a5a2 | 85 | <span class="c">/* 2000バイト戻す (ラップアラウンドに注意) */</span>\r |
| 53668523 L |
86 | res = f_lseek(fp, f_tell(fp) - 2000);\r |
| 87 | </pre>\r | |
| 88 | <pre>\r | |
| 7b78a5a2 | 89 | <span class="c">/* クラスタ先行割り当て (ストリーミング ライト時のバッファ オーバーラン防止) */</span>\r |
| 53668523 | 90 | \r |
| 7b78a5a2 | 91 | res = f_open(fp, "record.wav", FA_CREATE_NEW | FA_WRITE); <span class="c">/* ファイル作成 */</span>\r |
| 53668523 | 92 | \r |
| 7b78a5a2 L |
93 | res = f_lseek(fp, MAX_SIZE); <span class="c">/* 十分なクラスタの先行割り当て */</span>\r |
| 94 | if (res || f_tell(fp) != PRE_SIZE) ... <span class="c">/* 正しくファイルが拡張されたかチェック */</span>\r | |
| 53668523 | 95 | \r |
| 7b78a5a2 | 96 | res = f_lseek(fp, DATA_START); <span class="c">/* データ ストリームの記録(アロケーションディレイ無し) */</span>\r |
| 53668523 L |
97 | ...\r |
| 98 | \r | |
| 7b78a5a2 L |
99 | res = f_truncate(fp); <span class="c">/* 不要領域の切り捨て */</span>\r |
| 100 | res = f_lseek(fp, 0); <span class="c">/* ヘッダの記録 */</span>\r | |
| 53668523 L |
101 | ...\r |
| 102 | \r | |
| 103 | res = f_close(fp);\r | |
| 104 | </pre>\r | |
| 105 | <pre>\r | |
| 7b78a5a2 | 106 | <span class="c">/* 高速シーク機能を使う */</span>\r |
| 53668523 | 107 | \r |
| 7b78a5a2 | 108 | DWORD clmt[SZ_TBL]; <span class="c">/* リンク マップ テーブル格納バッファ */</span>\r |
| 53668523 | 109 | \r |
| 7b78a5a2 | 110 | res = f_lseek(fp, ofs1); <span class="c">/* 通常シーク (オープン時、cltblはNULLに初期化される) */</span>\r |
| 53668523 | 111 | \r |
| 7b78a5a2 L |
112 | fp->cltbl = clmt; <span class="c">/* 高速シーク機能の有効化 */</span>\r |
| 113 | clmt[0] = SZ_TBL; <span class="c">/* 先頭要素に配列要素数をセット */</span>\r | |
| 114 | res = f_lseek(fp, CREATE_LINKMAP); <span class="c">/* CLMTの作成 */</span>\r | |
| 53668523 L |
115 | ...\r |
| 116 | \r | |
| 7b78a5a2 | 117 | res = f_lseek(fp, ofs2); <span class="c">/* 以降、f_read/f_write/f_lseekでFATアクセスは発生しない */</span>\r |
| 53668523 L |
118 | </pre>\r |
| 119 | </div>\r | |
| 120 | \r | |
| 121 | \r | |
| 122 | <div class="para ref">\r | |
| 7b78a5a2 | 123 | <h4>参照</h4>\r |
| 53668523 L |
124 | <p><tt><a href="open.html">f_open</a>, <a href="sfile.html">FIL</a></tt></p>\r |
| 125 | </div>\r | |
| 126 | \r | |
| 7b78a5a2 | 127 | <p class="foot"><a href="../00index_j.html">戻る</a></p>\r |
| 53668523 L |
128 | </body>\r |
| 129 | </html>\r |