80 lines
2.2 KiB
HTML
80 lines
2.2 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<meta http-equiv="Content-Style-Type" content="text/css">
|
|
<link rel="up" title="FatFs" href="../00index_e.html">
|
|
<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
|
|
<title>FatFs - f_getfree</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="para">
|
|
<h2>f_getfree</h2>
|
|
<p>The f_getfree gets number of the free clusters.</p>
|
|
<pre>
|
|
FRESULT f_getfree (
|
|
DWORD* <em>Clusters</em> // Pointer to the variable to store number of free clusters.
|
|
);
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="para">
|
|
<h4>Parameters</h4>
|
|
<dl class="par">
|
|
<dt>Clusters</dt>
|
|
<dd>Pointer to the DWORD variable to store number of free clusters.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>Return Values</h4>
|
|
<dl class="ret">
|
|
<dt>FR_OK (0)</dt>
|
|
<dd>The function succeeded. The <tt><em>*Clusters</em></tt> havs number of free clusters.</dd>
|
|
<dt>FR_NOT_READY</dt>
|
|
<dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
|
|
<dt>FR_RW_ERROR</dt>
|
|
<dd>Any error occured in low level disk I/O.</dd>
|
|
<dt>FR_INCORRECT_DISK_CHANGE</dt>
|
|
<dd>Incorrect disk removal/change has occured.</dd>
|
|
<dt>FR_NOT_ENABLED</dt>
|
|
<dd>FatFs module is not enabled.</dd>
|
|
<dt>FR_NO_FILESYSTEM</dt>
|
|
<dd>There is no valid FAT partition on the disk.</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>Descriptions</h4>
|
|
<p>The f_getfree gets number of free clusters on the drive. The <tt>FatFs.sects_clust</tt> is indicating number of sectors per cluster, so that the free space in unit of byte can be calcurated with this. This function is not supported in read-only configuration and minimization level of >= 1.</p>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>Samples Code</h4>
|
|
<pre>
|
|
DWORD clust;
|
|
|
|
// Get free clusters
|
|
res = f_getfree(&clust);
|
|
if (res) die(res);
|
|
|
|
// Get free bytes
|
|
printf("%lu bytes available on the disk.\n", clust * FatFs->sects_clust * 512);
|
|
</pre>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>References</h4>
|
|
<p><tt><a href="sfatfs.html">FATFS</a></tt></p>
|
|
</div>
|
|
|
|
<p class="foot"><a href="../00index_e.html">Return</a></p>
|
|
</body>
|
|
</html>
|