lseek.html 7.5 KB

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