]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/ja/lseek.html
Import fatfs R0.12b
[z180-stamp.git] / fatfs / doc / ja / lseek.html
index 88e1ab2a549bdb4c43e0a72cda150bc459330214..00e4a958801c447d1020a41cdfc9ff7ba4158d94 100644 (file)
@@ -16,8 +16,8 @@
 <p>ファイルのリード/ライト ポインタを移動します。また、高速シーク機能使用時にはCLMT(後述)の作成にも使用します。</p>\r
 <pre>\r
 FRESULT f_lseek (\r
-  FIL* <span class="arg">fp</span>,    <span class="c">/* [IN] ファイル オブジェクト構造体へのポインタ */</span>\r
-  DWORD <span class="arg">ofs</span>   <span class="c">/* [IN] 移動先オフセット */</span>\r
+  FIL* <span class="arg">fp</span>,      <span class="c">/* [IN] ファイル オブジェクト構造体へのポインタ */</span>\r
+  FSIZE_t <span class="arg">ofs</span>   <span class="c">/* [IN] 移動先オフセット */</span>\r
 );\r
 </pre>\r
 </div>\r
@@ -28,7 +28,7 @@ FRESULT f_lseek (
 <dt>fp</dt>\r
 <dd>対象となるファイル オブジェクト構造体へのポインタを指定します。</dd>\r
 <dt>ofs</dt>\r
-<dd>移動先のオフセット(リード/ライト ポインタ)値。ファイル先頭からのオフセットをバイト単位で指定します。</dd>\r
+<dd>移動先のオフセット(リード/ライト ポインタ)値。ファイル先頭からのオフセットをバイト単位で指定します。データ型<tt>FSIZE_t</tt>は、<tt>DWORD</tt>(32-bit)または<tt>QWORD</tt>(64-bit)のエリアスで、exFATサポートの有無により切り替わります。</dd>\r
 </dl>\r
 </div>\r
 \r
@@ -39,7 +39,6 @@ FRESULT f_lseek (
 <a href="rc.html#ok">FR_OK</a>,\r
 <a href="rc.html#de">FR_DISK_ERR</a>,\r
 <a href="rc.html#ie">FR_INT_ERR</a>,\r
-<a href="rc.html#nr">FR_NOT_READY</a>,\r
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,\r
 <a href="rc.html#tm">FR_TIMEOUT</a>,\r
 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>\r
@@ -49,19 +48,19 @@ FRESULT f_lseek (
 \r
 <div class="para desc">\r
 <h4>解説</h4>\r
-<p>ファイルのリード/ライト ポインタ(次に読み出し・書き込みされるバイトのオフセット)を移動します。オフセットの原点はファイル先頭です。書き込みモードでファイル サイズより大きな値を指定すると、そこまでファイル サイズが拡張され、拡張された部分のデータは未定義となります。データを遅延無く高速に書き込みたいときは、予めこの関数で必要なサイズまでファイル サイズを拡張しておくと良いでしょう。<tt>f_lseek()</tt>が正常終了したあとは、リード/ライト ポインタが正しく移動したかチェックするべきです。リード/ライト ポインタが指定より小さいときは、次の原因が考えられます。</p>\r
+<p>ファイルのリード/ライト ポインタ(次に読み出し・書き込みされるバイトのオフセット)を移動します。オフセットの原点はファイル先頭です。書き込みモードでファイル サイズより大きな値を指定すると、そこまでファイル サイズが拡張され、拡張された部分のデータは未定義となります。データを遅延無く高速に書き込みたいときは、予めこの関数で必要なサイズまでファイル サイズを拡張しておくと良いでしょう。ファイルに連続したデータ領域を割り当てる必要があるときは、<tt>f_expand</tt>関数を使用してください。<tt>f_lseek</tt>関数が正常終了したあとは、リード/ライト ポインタが正しく移動したかチェックするべきです。リード/ライト ポインタが指定より小さいときは、次の原因が考えられます。</p>\r
 <ul>\r
 <li>非書き込みモードまたは高速シーク モードのため、ファイル サイズでクリップされた。</li>\r
 <li>ファイル拡張中にディスクが満杯になった。</li>\r
 </ul>\r
-<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
-<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
+<p>高速シーク モードは、ファイルのクラスタ配置情報(CLMT)をメモリ上に保持しておくことにより、FATにアクセスすることなく後方シークやロング シークを高速に行う機能で、シーク動作のほか<tt>f_read/f_wtite</tt>関数の動作にも適用されます。ファイルが高速シーク モードの間は<tt>f_wtite/f_lseek</tt>関数によるファイル サイズの拡張はできません。</p>\r
+<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
 </div>\r
 \r
 \r
 <div class="para comp">\r
 <h4>対応情報</h4>\r
-<p><tt>_FS_MINIMIZE &lt; 3</tt>のとき使用可能です。</p>\r
+<p><tt>_FS_MINIMIZE &lt; 3</tt>のとき使用可能です。高速シーク モードを利用するときは、<tt><a href="config.html#use_fastseek">_USE_FASTSEEK</a> == 1</tt>である必要があります。</p>\r
 </div>\r
 \r
 \r
@@ -107,6 +106,8 @@ FRESULT f_lseek (
 \r
     DWORD clmt[SZ_TBL];                    <span class="c">/* リンク マップ テーブル格納バッファ */</span>\r
 \r
+    res = f_open(fp, fname, FA_READ | FA_WRITE);   <span class="c">/* ファイルを開く */</span>\r
+\r
     res = f_lseek(fp, ofs1);               <span class="c">/* 通常シーク (オープン時、cltblはNULLに初期化される) */</span>\r
 \r
     fp-&gt;cltbl = clmt;                      <span class="c">/* 高速シーク機能の有効化 */</span>\r
@@ -121,7 +122,7 @@ FRESULT f_lseek (
 \r
 <div class="para ref">\r
 <h4>参照</h4>\r
-<p><tt><a href="open.html">f_open</a>, <a href="sfile.html">FIL</a></tt></p>\r
+<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
 </div>\r
 \r
 <p class="foot"><a href="../00index_j.html">戻る</a></p>\r