getfree.html 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  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/getfree.html">
  8. <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
  9. <title>FatFs - f_getfree</title>
  10. </head>
  11. <body>
  12. <div class="para func">
  13. <h2>f_getfree</h2>
  14. <p>ボリューム上の空き領域のサイズを取得します。</p>
  15. <pre>
  16. FRESULT f_getfree (
  17. const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] 対象ドライブを指定します */</span>
  18. DWORD* <span class="arg">nclst</span>, <span class="c">/* [OUT] 空きクラスタ数を格納する変数へのポインタ */</span>
  19. FATFS** <span class="arg">fatfs</span> <span class="c">/* [OUT] ファイル システム オブジェクトを指すポインタへのポインタ */</span>
  20. );
  21. </pre>
  22. </div>
  23. <div class="para arg">
  24. <h4>引数</h4>
  25. <dl class="par">
  26. <dt>path</dt>
  27. <dd>調べる対象の論理ドライブを示す<a href="filename.html">パス名</a>を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。ヌル文字列はカレント ドライブを意味します。</dd>
  28. <dt>nclst</dt>
  29. <dd>空きクラスタ数を格納する<tt>DWORD</tt>型変数へのポインタを指定します。</dd>
  30. <dt>fatfs</dt>
  31. <dd>対象ドライブのファイル システム オブジェクトを指すポインタが返されます。</dd>
  32. </dl>
  33. </div>
  34. <div class="para ret">
  35. <h4>戻り値</h4>
  36. <p>
  37. <a href="rc.html#ok">FR_OK</a>,
  38. <a href="rc.html#de">FR_DISK_ERR</a>,
  39. <a href="rc.html#ie">FR_INT_ERR</a>,
  40. <a href="rc.html#nr">FR_NOT_READY</a>,
  41. <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  42. <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  43. <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  44. <a href="rc.html#tm">FR_TIMEOUT</a>
  45. </p>
  46. </div>
  47. <div class="para desc">
  48. <h4>解説</h4>
  49. <p>論理ドライブ上の空き領域のサイズをクラスタ単位で取得します。返されたファイル システム オブジェクトの<tt>csize</tt>メンバがクラスタあたりのセクタ数を示しているので、これを元にセクタ単位の空きサイズが計算できます。FAT32ボリュームにおいては、FSINFOの情報が実際の空きクラスタ数と同期していない場合、不正確な値を返す可能性があります。この問題を避けるため、<tt><a href="config.html#fs_nofsinfo">_FS_NOFSINFO</a></tt>オプションでマウント後の初回は必ずフルFATスキャンをするように構成することもできます。</p>
  50. </div>
  51. <div class="para comp">
  52. <h4>対応情報</h4>
  53. <p><tt>_FS_READONLY == 0</tt>で、且つ<tt>_FS_MINIMIZE == 0</tt>のとき使用可能です。</p>
  54. </div>
  55. <div class="para use">
  56. <h4>使用例</h4>
  57. <pre>
  58. FATFS *fs;
  59. DWORD fre_clust, fre_sect, tot_sect;
  60. <span class="c">/* ドライブ1のボリューム情報と空きクラスタ数を得る */</span>
  61. res = f_getfree("1:", &amp;fre_clust, &amp;fs);
  62. if (res) die(res);
  63. <span class="c">/* 全セクタ数と空きセクタ数を計算 */</span>
  64. tot_sect = (fs->n_fatent - 2) * fs->csize;
  65. fre_sect = fre_clust * fs->csize;
  66. <span class="c">/* ボリュームのサイズと空きサイズを表示 (512バイト/セクタと仮定) */</span>
  67. printf("%10lu KiB total drive space.\n%10lu KiB available.\n",
  68. tot_sect / 2, fre_sect / 2);
  69. </pre>
  70. </div>
  71. <div class="para ref">
  72. <h4>参照</h4>
  73. <tt><a href="sfatfs.html">FATFS</a></tt>
  74. </div>
  75. <p class="foot"><a href="../00index_j.html">戻る</a></p>
  76. </body>
  77. </html>