]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/ja/getfree.html
Merge branch 'chan-fatfs' into fatfs-integration
[z180-stamp.git] / fatfs / doc / ja / getfree.html
index 4de40de9b53ef17059fafd45effe63c664f970aa..bb2a4527b4eb20ceb9487624250ba07833cfc150 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/getfree.html">\r
 \r
 <div class="para func">\r
 <h2>f_getfree</h2>\r
-<p>\83{\83\8a\83\85\81[\83\80\8fã\82Ì\8bó\82«\97Ì\88æ\82Ì\83T\83C\83Y\82ð\8eæ\93¾\82µ\82Ü\82·\81B</p>\r
+<p>ボリューム上の空き領域のサイズを取得します。</p>\r
 <pre>\r
 FRESULT f_getfree (\r
-  const TCHAR* <span class="arg">path</span>,  <span class="c">/* [IN] \91Î\8fÛ\83h\83\89\83C\83u\82ð\8ew\92è\82µ\82Ü\82· */</span>\r
-  DWORD* <span class="arg">nclst</span>,       <span class="c">/* [OUT] \8bó\82«\83N\83\89\83X\83^\90\94\82ð\8ai\94[\82·\82é\95Ï\90\94\82Ö\82Ì\83|\83C\83\93\83^ */</span>\r
-  FATFS** <span class="arg">fatfs</span>       <span class="c">/* [OUT] \83t\83@\83C\83\8b\81E\83V\83X\83e\83\80\81E\83I\83u\83W\83F\83N\83g\82ð\8ew\82·\83|\83C\83\93\83^\82Ö\82Ì\83|\83C\83\93\83^ */</span>\r
+  const TCHAR* <span class="arg">path</span>,  <span class="c">/* [IN] 対象ドライブを指定します */</span>\r
+  DWORD* <span class="arg">nclst</span>,       <span class="c">/* [OUT] 空きクラスタ数を格納する変数へのポインタ */</span>\r
+  FATFS** <span class="arg">fatfs</span>       <span class="c">/* [OUT] ファイル システム オブジェクトを指すポインタへのポインタ */</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>path</dt>\r
-<dd>\92²\82×\82é\91Î\8fÛ\82Ì\98_\97\9d\83h\83\89\83C\83u\82ð\8e¦\82·<a href="filename.html">\83p\83X\96¼</a>\82ð\8e¦\82·\83k\83\8b\95\8e\9a<tt>'\0'</tt>\8fI\92[\82Ì\95\8e\9a\97ñ\82Ö\82Ì\83|\83C\83\93\83^\82ð\8ew\92è\82µ\82Ü\82·\81B\83k\83\8b\95\8e\9a\97ñ\82Í\83J\83\8c\83\93\83g\81E\83h\83\89\83C\83u\82ð\88Ó\96¡\82µ\82Ü\82·\81B</dd>\r
+<dd>調べる対象の論理ドライブを示す<a href="filename.html">パス名</a>を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。ヌル文字列はカレント ドライブを意味します。</dd>\r
 <dt>nclst</dt>\r
-<dd>\8bó\82«\83N\83\89\83X\83^\90\94\82ð\8ai\94[\82·\82é<tt>DWORD</tt>\8c^\95Ï\90\94\82Ö\82Ì\83|\83C\83\93\83^\82ð\8ew\92è\82µ\82Ü\82·\81B</dd>\r
+<dd>空きクラスタ数を格納する<tt>DWORD</tt>型変数へのポインタを指定します。</dd>\r
 <dt>fatfs</dt>\r
-<dd>\91Î\8fÛ\83h\83\89\83C\83u\82Ì\83t\83@\83C\83\8b\81E\83V\83X\83e\83\80\81E\83I\83u\83W\83F\83N\83g\82ð\8ew\82·\83|\83C\83\93\83^\82ª\95Ô\82³\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
@@ -52,33 +52,33 @@ FRESULT f_getfree (
 \r
 \r
 <div class="para desc">\r
-<h4>\89ð\90à</h4>\r
-<p>\98_\97\9d\83h\83\89\83C\83u\8fã\82Ì\8bó\82«\97Ì\88æ\82Ì\83T\83C\83Y\82ð\83N\83\89\83X\83^\92P\88Ê\82Å\8eæ\93¾\82µ\82Ü\82·\81B\95Ô\82³\82ê\82½\83t\83@\83C\83\8b\81E\83V\83X\83e\83\80\81E\83I\83u\83W\83F\83N\83g\82Ì<tt>csize</tt>\83\81\83\93\83o\82ª\83N\83\89\83X\83^\82 \82½\82è\82Ì\83Z\83N\83^\90\94\82ð\8e¦\82µ\82Ä\82¢\82é\82Ì\82Å\81A\82±\82ê\82ð\8c³\82É\83Z\83N\83^\92P\88Ê\82Ì\8bó\82«\83T\83C\83Y\82ª\8cv\8eZ\82Å\82«\82Ü\82·\81BFAT32\83{\83\8a\83\85\81[\83\80\82É\82¨\82¢\82Ä\82Í\81AFSINFO\82Ì\8fî\95ñ\82ª\8eÀ\8dÛ\82Ì\8bó\82«\83N\83\89\83X\83^\90\94\82Æ\93¯\8aú\82µ\82Ä\82¢\82È\82¢\8fê\8d\87\81A\95s\90³\8am\82È\92l\82ð\95Ô\82·\89Â\94\\90«\82ª\82 \82è\82Ü\82·\81B\82±\82Ì\96â\91è\82ð\94ð\82¯\82é\82½\82ß\81A<tt>_FS_NOFSINFO</tt>\83I\83v\83V\83\87\83\93\82Å\83}\83E\83\93\83g\8cã\82Ì\8f\89\89ñ\82Í\95K\82¸\83t\83\8bFAT\83X\83L\83\83\83\93\82ð\82·\82é\82æ\82¤\82É\8d\\90¬\82·\82é\82±\82Æ\82à\82Å\82«\82Ü\82·\81B</p>\r
+<h4>解説</h4>\r
+<p>論理ドライブ上の空き領域のサイズをクラスタ単位で取得します。返されたファイル システム オブジェクトの<tt>csize</tt>メンバがクラスタあたりのセクタ数を示しているので、これを元にセクタ単位の空きサイズが計算できます。FAT32ボリュームにおいては、FSINFOの情報が実際の空きクラスタ数と同期していない場合、不正確な値を返す可能性があります。この問題を避けるため、<tt><a href="config.html#fs_nofsinfo">_FS_NOFSINFO</a></tt>オプションでマウント後の初回は必ずフルFATスキャンをするように構成することもできます。</p>\r
 </div>\r
 \r
 \r
 <div class="para comp">\r
-<h4>\91Î\89\9e\8fî\95ñ</h4>\r
-<p><tt>_FS_READONLY == 0</tt>\82Å\81A\8a\8e\82Â<tt>_FS_MINIMIZE == 0</tt>\82Ì\82Æ\82«\8eg\97p\89Â\94\\82Å\82·\81B</p>\r
+<h4>対応情報</h4>\r
+<p><tt>_FS_READONLY == 0</tt>で、且つ<tt>_FS_MINIMIZE == 0</tt>のとき使用可能です。</p>\r
 </div>\r
 \r
 \r
 <div class="para use">\r
-<h4>\8eg\97p\97á</h4>\r
+<h4>使用例</h4>\r
 <pre>\r
     FATFS *fs;\r
     DWORD fre_clust, fre_sect, tot_sect;\r
 \r
 \r
-    <span class="c">/* \83h\83\89\83C\83u1\82Ì\83{\83\8a\83\85\81[\83\80\8fî\95ñ\82Æ\8bó\82«\83N\83\89\83X\83^\90\94\82ð\93¾\82é */</span>\r
+    <span class="c">/* ドライブ1のボリューム情報と空きクラスタ数を得る */</span>\r
     res = f_getfree("1:", &amp;fre_clust, &amp;fs);\r
     if (res) die(res);\r
 \r
-    <span class="c">/* \91S\83Z\83N\83^\90\94\82Æ\8bó\82«\83Z\83N\83^\90\94\82ð\8cv\8eZ */</span>\r
+    <span class="c">/* 全セクタ数と空きセクタ数を計算 */</span>\r
     tot_sect = (fs->n_fatent - 2) * fs->csize;\r
     fre_sect = fre_clust * fs->csize;\r
 \r
-    <span class="c">/* \83{\83\8a\83\85\81[\83\80\91S\91Ì\82Ì\83T\83C\83Y\82Æ\8bó\82«\82Ì\83T\83C\83Y\82ð\95\\8e¦ (512\83o\83C\83g/\83Z\83N\83^\82Æ\89¼\92è) */</span>\r
+    <span class="c">/* ボリュームのサイズと空きサイズを表示 (512バイト/セクタと仮定) */</span>\r
     printf("%10lu KiB total drive space.\n%10lu KiB available.\n",\r
            tot_sect / 2, fre_sect / 2);\r
 </pre>\r
@@ -86,10 +86,10 @@ FRESULT f_getfree (
 \r
 \r
 <div class="para ref">\r
-<h4>\8eQ\8fÆ</h4>\r
+<h4>参照</h4>\r
 <tt><a href="sfatfs.html">FATFS</a></tt>\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