diff options
| author | Yuval Adam <yuv.adm@gmail.com> | 2014-08-08 14:42:07 +0300 |
|---|---|---|
| committer | Yuval Adam <yuv.adm@gmail.com> | 2014-08-08 14:42:07 +0300 |
| commit | a6163888f3c56123b1db313743c6147ba498732c (patch) | |
| tree | ff7d15d991d1d09ba6cbc0cec80924f57445bfdd /third_party/fatfs/doc/ja/getfree.html | |
| parent | c3e4c9a25c2910d2d66d52215b3406b13d5b23d5 (diff) | |
Add third_party libs
Diffstat (limited to 'third_party/fatfs/doc/ja/getfree.html')
| -rw-r--r-- | third_party/fatfs/doc/ja/getfree.html | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/third_party/fatfs/doc/ja/getfree.html b/third_party/fatfs/doc/ja/getfree.html new file mode 100644 index 0000000..eb328e7 --- /dev/null +++ b/third_party/fatfs/doc/ja/getfree.html @@ -0,0 +1,91 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang="ja">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<link rel="up" title="FatFs" href="../00index_j.html">
+<link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
+<title>FatFs - f_getfree</title>
+</head>
+
+<body>
+
+<div class="para">
+<h2>f_getfree</h2>
+<p>論理ドライブ上の未使用クラスタ数を得ます。</p>
+<pre>
+FRESULT f_getfree (
+ const char* <em>Path</em>, /* 対象ドライブのルート・ディレクトリ */
+ DWORD* <em>Clusters</em>, /* 空きクラスタ数を格納する変数へのポインタ */
+ FATFS** <em>FileSystemObject</em> /* ファイル・システム・オブジェクトを指すポインタへのポインタ */
+);
+</pre>
+</div>
+
+<div class="para">
+<h4>引数</h4>
+<dl class="par">
+<dt>Path</dt>
+<dd>対象の論理ドライブのルートディレクトリの<a href="filename.html">パス名</a>が入った<tt>'\0'</tt>で終わる文字列へのポインタを指定します。</dd>
+<dt>Clusters</dt>
+<dd>空きクラスタ数を格納する<tt>DWORD</tt>変数へのポインタを指定します。</dd>
+<dt>FileSystemObject</dt>
+<dd>対象ドライブのファイル・システム・オブジェクトを指すポインタが返されます。</dd>
+</dl>
+</div>
+
+
+<div class="para">
+<h4>戻り値</h4>
+<dl class="ret">
+<dt>FR_OK (0)</dt>
+<dd>正常終了。<tt>*Clusters</tt>に空きクラスタ数が返されます。</dd>
+<dt>FR_INVALID_DRIVE</dt>
+<dd>ドライブ番号が不正。</dd>
+<dt>FR_NOT_READY</dt>
+<dd>メディアがセットされていないなど、ディスクドライブが動作不能状態。</dd>
+<dt>FR_RW_ERROR</dt>
+<dd>ディスク・エラーまたは内部エラーによる失敗。</dd>
+<dt>FR_NOT_ENABLED</dt>
+<dd>その論理ドライブにワーク・エリアが与えられていない。</dd>
+<dt>FR_NO_FILESYSTEM</dt>
+<dd>ディスク上に有効なFATパーテーションが見つからない。</dd>
+</dl>
+</div>
+
+
+<div class="para">
+<h4>解説</h4>
+<p>論理ドライブ上の空きクラスタ数を取得します。返されたファイル・システム・オブジェクトの<tt>sects_clust</tt>メンバがクラスタあたりのセクタ数を示しているので、これを元に実際の空きサイズが計算できます。FAT32ボリュームにおいて、_USE_FSINFOが指定されている場合、不正確な値を返す場合があります。指定されていない場合、処理に時間がかかります。</p>
+<p>リードオンリー構成および<tt>_FS_MINIMIZE >= 1</tt>ではこの関数はサポートされません。</p>
+</div>
+
+
+<div class="para">
+<h4>使用例</h4>
+<pre>
+ FATFS *fs;
+ DWORD clust;
+
+
+ // Get free clusters
+ res = f_getfree("", &clust, &fs);
+ if (res) die(res);
+
+ // Get free space
+ printf("%lu KB total disk space.\n"
+ "%lu KB available on the disk.\n",
+ (DWORD)(fs->max_clust - 2) * fs->sects_clust / 2,
+ clust * fs->sects_clust / 2);
+</pre>
+</div>
+
+
+<div class="para">
+<h4>参照</h4>
+<tt><a href="sfatfs.html">FATFS</a></tt>
+</div>
+
+<p class="foot"><a href="../00index_j.html">戻る</a></p>
+</body>
+</html>
|