]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/ja/lseek.html
Import fatfs R0.10c
[z180-stamp.git] / fatfs / doc / ja / lseek.html
index 55788526279c8a118c9932369419306f762098d1..88e1ab2a549bdb4c43e0a72cda150bc459330214 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
 <html lang="ja">\r
 <head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS">\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
 <meta http-equiv="Content-Style-Type" content="text/css">\r
 <link rel="up" title="FatFs" href="../00index_j.html">\r
 <link rel="alternate" hreflang="en" title="English" href="../en/lseek.html">\r
 \r
 <div class="para func">\r
 <h2>f_lseek</h2>\r
-<p>\83t\83@\83C\83\8b\82Ì\83\8a\81[\83h/\83\89\83C\83g\81E\83|\83C\83\93\83^\82ð\88Ú\93®\82µ\82Ü\82·\81B\82Ü\82½\81A\8d\82\91¬\83V\81[\83N\8b@\94\\8eg\97p\8e\9e\82É\82ÍCLMT(\8cã\8fq)\82Ì\8dì\90¬\82É\82à\8eg\97p\82µ\82Ü\82·\81B</p>\r
+<p>ファイルのリード/ライト ポインタを移動します。また、高速シーク機能使用時にはCLMT(後述)の作成にも使用します。</p>\r
 <pre>\r
 FRESULT f_lseek (\r
-  FIL* <span class="arg">fp</span>,    <span class="c">/* [IN] \83t\83@\83C\83\8b\81E\83I\83u\83W\83F\83N\83g\8d\\91¢\91Ì\82Ö\82Ì\83|\83C\83\93\83^ */</span>\r
-  DWORD <span class="arg">ofs</span>   <span class="c">/* [IN] \88Ú\93®\90æ\83I\83t\83Z\83b\83g */</span>\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
 );\r
 </pre>\r
 </div>\r
 \r
 <div class="para arg">\r
-<h4>\88ø\90\94</h4>\r
+<h4>引数</h4>\r
 <dl class="par">\r
 <dt>fp</dt>\r
-<dd>\91Î\8fÛ\82Æ\82È\82é\83t\83@\83C\83\8b\81E\83I\83u\83W\83F\83N\83g\8d\\91¢\91Ì\82Ö\82Ì\83|\83C\83\93\83^\82ð\8ew\92è\82µ\82Ü\82·\81B</dd>\r
+<dd>対象となるファイル オブジェクト構造体へのポインタを指定します。</dd>\r
 <dt>ofs</dt>\r
-<dd>\88Ú\93®\90æ\82Ì\83I\83t\83Z\83b\83g(\83\8a\81[\83h/\83\89\83C\83g\81E\83|\83C\83\93\83^)\92l\81B\83t\83@\83C\83\8b\90æ\93ª\82©\82ç\82Ì\83I\83t\83Z\83b\83g\82ð\83o\83C\83g\92P\88Ê\82Å\8ew\92è\82µ\82Ü\82·\81B</dd>\r
+<dd>移動先のオフセット(リード/ライト ポインタ)値。ファイル先頭からのオフセットをバイト単位で指定します。</dd>\r
 </dl>\r
 </div>\r
 \r
 \r
 <div class="para ret">\r
-<h4>\96ß\82è\92l</h4>\r
+<h4>戻り値</h4>\r
 <p>\r
 <a href="rc.html#ok">FR_OK</a>,\r
 <a href="rc.html#de">FR_DISK_ERR</a>,\r
@@ -48,82 +48,82 @@ FRESULT f_lseek (
 \r
 \r
 <div class="para desc">\r
-<h4>\89ð\90à</h4>\r
-<p>\83t\83@\83C\83\8b\82Ì\83\8a\81[\83h/\83\89\83C\83g\81E\83|\83C\83\93\83^(\8e\9f\82É\93Ç\82Ý\8fo\82µ\81E\8f\91\82«\8d\9e\82Ý\82³\82ê\82é\83o\83C\83g\82Ì\83I\83t\83Z\83b\83g)\82ð\88Ú\93®\82µ\82Ü\82·\81B\83I\83t\83Z\83b\83g\82Ì\8c´\93_\82Í\83t\83@\83C\83\8b\90æ\93ª\82Å\82·\81B\8f\91\82«\8d\9e\82Ý\83\82\81[\83h\82Å\83t\83@\83C\83\8b\81E\83T\83C\83Y\82æ\82è\91å\82«\82È\92l\82ð\8ew\92è\82·\82é\82Æ\81A\82»\82±\82Ü\82Å\83t\83@\83C\83\8b\81E\83T\83C\83Y\82ª\8ag\92£\82³\82ê\81A\8ag\92£\82³\82ê\82½\95\94\95ª\82Ì\83f\81[\83^\82Í\96¢\92è\8b`\82Æ\82È\82è\82Ü\82·\81B\83f\81[\83^\82ð\92x\89\84\96³\82­\8d\82\91¬\82É\8f\91\82«\8d\9e\82Ý\82½\82¢\82Æ\82«\82Í\81A\97\\82ß\82±\82Ì\8aÖ\90\94\82Å\95K\97v\82È\83T\83C\83Y\82Ü\82Å\83t\83@\83C\83\8b\81E\83T\83C\83Y\82ð\8ag\92£\82µ\82Ä\82¨\82­\82Æ\97Ç\82¢\82Å\82µ\82å\82¤\81B<tt>f_lseek()</tt>\82ª\90³\8fí\8fI\97¹\82µ\82½\82 \82Æ\82Í\81A\83\8a\81[\83h/\83\89\83C\83g\81E\83|\83C\83\93\83^\82ª\90³\82µ\82­\88Ú\93®\82µ\82½\82©\83`\83F\83b\83N\82·\82é\82×\82«\82Å\82·\81B\83\8a\81[\83h/\83\89\83C\83g\81E\83|\83C\83\93\83^\82ª\8ew\92è\82æ\82è\8f¬\82³\82¢\82Æ\82«\82Í\81A\8e\9f\82Ì\8c´\88ö\82ª\8dl\82¦\82ç\82ê\82Ü\82·\81B</p>\r
+<h4>解説</h4>\r
+<p>ファイルのリード/ライト ポインタ(次に読み出し・書き込みされるバイトのオフセット)を移動します。オフセットの原点はファイル先頭です。書き込みモードでファイル サイズより大きな値を指定すると、そこまでファイル サイズが拡張され、拡張された部分のデータは未定義となります。データを遅延無く高速に書き込みたいときは、予めこの関数で必要なサイズまでファイル サイズを拡張しておくと良いでしょう。<tt>f_lseek()</tt>が正常終了したあとは、リード/ライト ポインタが正しく移動したかチェックするべきです。リード/ライト ポインタが指定より小さいときは、次の原因が考えられます。</p>\r
 <ul>\r
-<li>\94ñ\8f\91\82«\8d\9e\82Ý\83\82\81[\83h\82Ü\82½\82Í\8d\82\91¬\83V\81[\83N\81E\83\82\81[\83h\82Ì\82½\82ß\81A\83t\83@\83C\83\8b\81E\83T\83C\83Y\82Å\83N\83\8a\83b\83v\82³\82ê\82½\81B</li>\r
-<li>\83t\83@\83C\83\8b\8ag\92£\92\86\82É\83f\83B\83X\83N\82ª\96\9e\94t\82É\82È\82Á\82½\81B</li>\r
+<li>非書き込みモードまたは高速シーク モードのため、ファイル サイズでクリップされた。</li>\r
+<li>ファイル拡張中にディスクが満杯になった。</li>\r
 </ul>\r
-<p><tt>_USE_FASTSEEK</tt>\82ª1\82Å\81A\8a\8e\82Â\83t\83@\83C\83\8b\81E\83I\83u\83W\83F\83N\83g\82Ì<tt>cltbl</tt>\83\81\83\93\83o\82ªNULL\88È\8aO(<tt>f_open()</tt>\82ÅNULL\82É\90Ý\92è\82³\82ê\82é)\82Ì\82Æ\82«\81A\8d\82\91¬\83V\81[\83N\81E\83\82\81[\83h\82É\82È\82è\82Ü\82·\81B\82±\82ê\82Í\83t\83@\83C\83\8b\82Ì\83N\83\89\83X\83^\94z\92u\8fî\95ñ(CLMT)\82ð\83\81\83\82\83\8a\8fã\82É\95Û\8e\9d\82µ\82Ä\82¨\82­\82±\82Æ\82É\82æ\82è\81AFAT\82É\83A\83N\83Z\83X\82·\82é\82±\82Æ\82È\82­\8cã\95û\83V\81[\83N\82â\83\8d\83\93\83O\81E\83V\81[\83N\82ð\8d\82\91¬\82É\8ds\82¤\8b@\94\\82Å\82·\81B\8d\82\91¬\83V\81[\83N\81E\83\82\81[\83h\82Í\81A<tt>f_read()/f_wtite()</tt>\82Ì\93®\8dì\82É\82à\93K\97p\82³\82ê\82Ü\82·\81B\8d\82\91¬\83V\81[\83N\81E\83\82\81[\83h\82Å\82Í<tt>f_wtite()/f_lseek()</tt>\82É\82æ\82é\83t\83@\83C\83\8b\81E\83T\83C\83Y\82Ì\8ag\92£\82Í\82Å\82«\82Ü\82¹\82ñ\81B</p>\r
-<p>\8d\82\91¬\83V\81[\83N\93®\8dì\82ð\8ds\82¤\91O\82É\81ACLMT\82ð\8dì\90¬\82µ\82Ä\82¨\82­\95K\97v\82ª\82 \82è\82Ü\82·\81B\82±\82ê\82ð\8dì\90¬\82·\82é\82É\82Í\81A\82Ü\82¸CLMT\8ai\94[\83o\83b\83t\83@(<tt>DWORD</tt>\8c^\94z\97ñ)\82ð\8f\80\94õ\82µ\81A<tt>cltbl</tt>\83\81\83\93\83o\82É\82»\82Ì\83|\83C\83\93\83^\82ð\83Z\83b\83g\82µ\82Ü\82·\81B\82»\82µ\82Ä\81A\94z\97ñ\82Ì\90æ\93ª\97v\91f\82É\82»\82Ì\94z\97ñ\82Ì\83T\83C\83Y(\97v\91f\90\94)\82ð\93ü\82ê\81A<tt>f_lseek()</tt>\82ð<tt class="arg">ofs</tt>\82É<tt>CREATE_LINKMAP</tt>\82ð\8ew\92è\82µ\82Ä\8cÄ\82Ñ\8fo\82µ\82Ü\82·\81B\8aÖ\90\94\82ª\90¬\8c÷\82·\82é\82ÆCLMT\82ª\8dì\90¬\82³\82ê\81A\88È\8d~\82Ì<tt>f_read()/f_write()/f_lseek()</tt>\82Å\82ÍFAT\82Ö\82Ì\83A\83N\83Z\83X\82Í\94­\90\82µ\82Ü\82¹\82ñ\81B<tt>FR_NOT_ENOUGH_CORE</tt>\82Å\8e¸\94s\82µ\82½\82Æ\82«\82Í\94z\97ñ\83T\83C\83Y\82ª\95s\91«\82Å\81A\90æ\93ª\97v\91f\82É\82Í\8eÀ\8dÛ\82É\95K\97v\82Æ\82È\82é\97v\91f\90\94\82ª\95Ô\82³\82ê\82Ü\82·\81B\95K\97v\82È\97v\91f\90\94\82Í\81A(\83t\83@\83C\83\8b\82Ì\95ª\8a\84\90\94 + 1) * 2 \82Å\82·\81B\82½\82Æ\82¦\82Î\81A\83t\83@\83C\83\8b\82ª5\82Â\82Ì\83t\83\89\83O\83\81\83\93\83g\82É\95ª\92f\82³\82ê\82Ä\82¢\82é\82Æ\82«\82É\95K\97v\82È\97v\91f\90\94\82Í\81A12\82Æ\82È\82è\82Ü\82·\81B</p>\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
 </div>\r
 \r
 \r
 <div class="para comp">\r
-<h4>\91Î\89\9e\8fî\95ñ</h4>\r
-<p><tt>_FS_MINIMIZE &lt; 3</tt>\82Ì\82Æ\82«\8eg\97p\89Â\94\\82Å\82·\81B</p>\r
+<h4>対応情報</h4>\r
+<p><tt>_FS_MINIMIZE &lt; 3</tt>のとき使用可能です。</p>\r
 </div>\r
 \r
 \r
 <div class="para use">\r
-<h4>\8eg\97p\97á</h4>\r
+<h4>使用例</h4>\r
 <pre>\r
-    <span class="c">/* \83t\83@\83C\83\8b\82ð\8aJ\82­ */</span>\r
+    <span class="c">/* ファイルを開く */</span>\r
     fp = malloc(sizeof (FIL));\r
     res = f_open(fp, "file.dat", FA_READ|FA_WRITE);\r
     if (res) ...\r
 \r
-    <span class="c">/* \83t\83@\83C\83\8b\81E\83I\83t\83Z\83b\83g5000\82Ö\88Ú\93® */</span>\r
+    <span class="c">/* ファイル オフセット5000へ移動 */</span>\r
     res = f_lseek(fp, 5000);\r
 \r
-    <span class="c">/* \83t\83@\83C\83\8b\8fI\92[\82Ö\88Ú\93®(\83t\83@\83C\83\8b\92Ç\8bL\82Ì\8f\80\94õ) */</span>\r
+    <span class="c">/* ファイル終端へ移動(ファイル追記の準備) */</span>\r
     res = f_lseek(fp, f_size(fp));\r
 \r
-    <span class="c">/* 3000\83o\83C\83g\90i\82ß\82é */</span>\r
+    <span class="c">/* 3000バイト進める */</span>\r
     res = f_lseek(fp, f_tell(fp) + 3000);\r
 \r
-    <span class="c">/* 2000\83o\83C\83g\96ß\82· (\83\89\83b\83v\83A\83\89\83E\83\93\83h\82É\92\8d\88Ó) */</span>\r
+    <span class="c">/* 2000バイト戻す (ラップアラウンドに注意) */</span>\r
     res = f_lseek(fp, f_tell(fp) - 2000);\r
 </pre>\r
 <pre>\r
-<span class="c">/* \83N\83\89\83X\83^\90æ\8ds\8a\84\82è\93\96\82Ä (\83X\83g\83\8a\81[\83~\83\93\83O\81E\83\89\83C\83g\8e\9e\82Ì\83o\83b\83t\83@\81E\83I\81[\83o\81[\83\89\83\93\96h\8e~) */</span>\r
+<span class="c">/* クラスタ先行割り当て (ストリーミング ライト時のバッファ オーバーラン防止) */</span>\r
 \r
-    res = f_open(fp, "record.wav", FA_CREATE_NEW | FA_WRITE);    <span class="c">/* \83t\83@\83C\83\8b\8dì\90¬ */</span>\r
+    res = f_open(fp, "record.wav", FA_CREATE_NEW | FA_WRITE);    <span class="c">/* ファイル作成 */</span>\r
 \r
-    res = f_lseek(fp, MAX_SIZE);             <span class="c">/* \8f\\95ª\82È\83N\83\89\83X\83^\82Ì\90æ\8ds\8a\84\82è\93\96\82Ä */</span>\r
-    if (res || f_tell(fp) != PRE_SIZE) ...   <span class="c">/* \90³\82µ\82­\83t\83@\83C\83\8b\82ª\8ag\92£\82³\82ê\82½\82©\83`\83F\83b\83N */</span>\r
+    res = f_lseek(fp, MAX_SIZE);             <span class="c">/* 十分なクラスタの先行割り当て */</span>\r
+    if (res || f_tell(fp) != PRE_SIZE) ...   <span class="c">/* 正しくファイルが拡張されたかチェック */</span>\r
 \r
-    res = f_lseek(fp, DATA_START);           <span class="c">/* \83f\81[\83^\81E\83X\83g\83\8a\81[\83\80\82Ì\8bL\98^(\83A\83\8d\83P\81[\83V\83\87\83\93\83f\83B\83\8c\83C\96³\82µ) */</span>\r
+    res = f_lseek(fp, DATA_START);           <span class="c">/* データ ストリームの記録(アロケーションディレイ無し) */</span>\r
     ...\r
 \r
-    res = f_truncate(fp);                    <span class="c">/* \95s\97v\97Ì\88æ\82Ì\90Ø\82è\8eÌ\82Ä */</span>\r
-    res = f_lseek(fp, 0);                    <span class="c">/* \83w\83b\83_\82Ì\8bL\98^ */</span>\r
+    res = f_truncate(fp);                    <span class="c">/* 不要領域の切り捨て */</span>\r
+    res = f_lseek(fp, 0);                    <span class="c">/* ヘッダの記録 */</span>\r
     ...\r
 \r
     res = f_close(fp);\r
 </pre>\r
 <pre>\r
-<span class="c">/* \8d\82\91¬\83V\81[\83N\8b@\94\\82ð\8eg\82¤ */</span>\r
+<span class="c">/* 高速シーク機能を使う */</span>\r
 \r
-    DWORD clmt[SZ_TBL];                    <span class="c">/* \83\8a\83\93\83N\81E\83}\83b\83v\81E\83e\81[\83u\83\8b\8ai\94[\83o\83b\83t\83@ */</span>\r
+    DWORD clmt[SZ_TBL];                    <span class="c">/* リンク マップ テーブル格納バッファ */</span>\r
 \r
-    res = f_lseek(fp, ofs1);               <span class="c">/* \92Ê\8fí\83V\81[\83N (\83I\81[\83v\83\93\8e\9e\81Acltbl\82ÍNULL\82É\8f\89\8aú\89»\82³\82ê\82é) */</span>\r
+    res = f_lseek(fp, ofs1);               <span class="c">/* 通常シーク (オープン時、cltblはNULLに初期化される) */</span>\r
 \r
-    fp-&gt;cltbl = clmt;                      <span class="c">/* \8d\82\91¬\83V\81[\83N\8b@\94\\82Ì\97L\8cø\89» */</span>\r
-    clmt[0] = SZ_TBL;                      <span class="c">/* \90æ\93ª\97v\91f\82É\94z\97ñ\97v\91f\90\94\82ð\83Z\83b\83g */</span>\r
-    res = f_lseek(fp, CREATE_LINKMAP);     <span class="c">/* CLMT\82Ì\8dì\90¬ */</span>\r
+    fp-&gt;cltbl = clmt;                      <span class="c">/* 高速シーク機能の有効化 */</span>\r
+    clmt[0] = SZ_TBL;                      <span class="c">/* 先頭要素に配列要素数をセット */</span>\r
+    res = f_lseek(fp, CREATE_LINKMAP);     <span class="c">/* CLMTの作成 */</span>\r
     ...\r
 \r
-    res = f_lseek(fp, ofs2);               <span class="c">/* \88È\8d~\81Af_read/f_write/f_lseek\82ÅFAT\83A\83N\83Z\83X\82Í\94­\90\82µ\82È\82¢ */</span>\r
+    res = f_lseek(fp, ofs2);               <span class="c">/* 以降、f_read/f_write/f_lseekでFATアクセスは発生しない */</span>\r
 </pre>\r
 </div>\r
 \r
 \r
 <div class="para ref">\r
-<h4>\8eQ\8fÆ</h4>\r
+<h4>参照</h4>\r
 <p><tt><a href="open.html">f_open</a>, <a href="sfile.html">FIL</a></tt></p>\r
 </div>\r
 \r
-<p class="foot"><a href="../00index_j.html">\96ß\82é</a></p>\r
+<p class="foot"><a href="../00index_j.html">戻る</a></p>\r
 </body>\r
 </html>\r