summaryrefslogtreecommitdiff
path: root/fatfs/doc/en/stat.html
diff options
context:
space:
mode:
Diffstat (limited to 'fatfs/doc/en/stat.html')
-rw-r--r--fatfs/doc/en/stat.html40
1 files changed, 40 insertions, 0 deletions
diff --git a/fatfs/doc/en/stat.html b/fatfs/doc/en/stat.html
index 8ea343b..db53c5d 100644
--- a/fatfs/doc/en/stat.html
+++ b/fatfs/doc/en/stat.html
@@ -55,6 +55,7 @@ FRESULT f_stat (
<div class="para desc">
<h4>Description</h4>
<p>The <tt>f_stat()</tt> function checks the existence of a file or sub-directory. If not exist, the function returns with <tt>FR_NO_FILE</tt>. If exist, the function returns with <tt>FR_OK</tt> and the informations of the object, file size, timestamp, attribute and SFN, are stored to the file information structure. For details of the file information, refer to the <tt>FILINFO</tt> structure and <a href="readdir.html"><tt>f_readdir()</tt></a> function.</p>
+<p>When LFN feature is enabled, <tt>lfname</tt> in the file information structure must be NULLed prior to use it.</p>
</div>
@@ -64,6 +65,45 @@ FRESULT f_stat (
</div>
+<div class="para use">
+<h4>Example</h4>
+<pre>
+ FRESULT fr;
+ FILINFO fno;
+
+
+ printf("Test for 'file.txt'...\n");
+
+<span class="k">#if</span> _USE_LFN
+ fno.lfname = 0;
+<span class="k">#endif</span>
+ fr = f_stat("file.txt", &amp;fno);
+ switch (fr) {
+
+ case FR_OK:
+ printf("Size: %u\n", fno.fsize);
+ printf("Timestamp: %u/%02u/%02u, %02u:%02u\n",
+ (fno.fdate &gt;&gt; 9) + 1980, fno.fdate &gt;&gt; 5 &amp; 15, fno.fdate &amp; 31,
+ fno.ftime &gt;&gt; 11, fno.ftime &gt;&gt; 5 &amp; 63);
+ printf("Attributes: %c%c%c%c%c\n",
+ (fno.fattrib & AM_DIR) ? 'D' : '-',
+ (fno.fattrib & AM_RDO) ? 'R' : '-',
+ (fno.fattrib & AM_HID) ? 'H' : '-',
+ (fno.fattrib & AM_SYS) ? 'S' : '-',
+ (fno.fattrib & AM_ARC) ? 'A' : '-');
+ break;
+
+ case FR_NO_FILE:
+ printf("It is not exist.\n");
+ break;
+
+ default:
+ printf("An error occured. (%d)\n", fr);
+ }
+</pre>
+</div>
+
+
<div class="para ref">
<h4>References</h4>
<p><tt><a href="opendir.html">f_opendir</a>, <a href="readdir.html">f_readdir</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>