summaryrefslogtreecommitdiff
path: root/fatfs/doc/en/sfileinfo.html
diff options
context:
space:
mode:
Diffstat (limited to 'fatfs/doc/en/sfileinfo.html')
-rw-r--r--fatfs/doc/en/sfileinfo.html33
1 files changed, 16 insertions, 17 deletions
diff --git a/fatfs/doc/en/sfileinfo.html b/fatfs/doc/en/sfileinfo.html
index ac254a1..6dae1fe 100644
--- a/fatfs/doc/en/sfileinfo.html
+++ b/fatfs/doc/en/sfileinfo.html
@@ -13,17 +13,18 @@
<div class="para">
<h2>FILINFO</h2>
-<p>The <tt>FILINFO</tt> structure holds a file information returned by <tt>f_readdir()</tt> and <tt>f_stat()</tt> function.</p>
+<p>The <tt>FILINFO</tt> structure holds information about the object returned by <tt>f_readdir</tt>, <tt>f_findfirst</tt>, <tt>f_findnext</tt> and <tt>f_stat</tt> function.</p>
<pre>
<span class="k">typedef struct</span> {
- DWORD fsize; <span class="c">/* File size */</span>
- WORD fdate; <span class="c">/* Last modified date */</span>
- WORD ftime; <span class="c">/* Last modified time */</span>
- BYTE fattrib; <span class="c">/* Attribute */</span>
- TCHAR fname[13]; <span class="c">/* Short file name (8.3 format) */</span>
-<span class="k">#if</span> _USE_LFN
- TCHAR* lfname; <span class="c">/* Pointer to the LFN buffer */</span>
- int lfsize; <span class="c">/* Size of the LFN buffer in unit of TCHAR */</span>
+ FSIZE_t fsize; <span class="c">/* File size */</span>
+ WORD fdate; <span class="c">/* Last modified date */</span>
+ WORD ftime; <span class="c">/* Last modified time */</span>
+ BYTE fattrib; <span class="c">/* Attribute */</span>
+<span class="k">#if</span> _USE_LFN != 0
+ TCHAR altname[13]; <span class="c">/* Alternative object name */</span>
+ TCHAR fname[_MAX_LFN + 1]; <span class="c">/* Primary object name */</span>
+<span class="k">#else</span>
+ TCHAR fname[13]; <span class="c">/* Object name */</span>
<span class="k">#endif</span>
} FILINFO;
</pre>
@@ -32,9 +33,9 @@
<h4>Members</h4>
<dl>
<dt>fsize</dt>
-<dd>Indicates size of the file in unit of byte. Always zero for directories.</dd>
+<dd>Indicates size of the file in unit of byte. <tt>FSIZE_t</tt> is an alias of integer type either <tt>DWORD</tt>(32-bit) or <tt>QWORD</tt>(64-bit) depends on the configuration option <tt>_FS_EXFAT</tt>. Do not care when the item is a directory.</dd>
<dt>fdate</dt>
-<dd>Indicates the date that the file was modified or the directory was created.<br>
+<dd>Indicates the date when the file was modified or the directory was created.<br>
<dl>
<dt>bit15:9</dt>
<dd>Year origin from 1980 (0..127)</dd>
@@ -45,7 +46,7 @@
</dl>
</dd>
<dt>ftime</dt>
-<dd>Indicates the time that the file was modified or the directory was created.<br>
+<dd>Indicates the time when the file was modified or the directory was created.<br>
<dl>
<dt>bit15:11</dt>
<dd>Hour (0..23)</dd>
@@ -58,11 +59,9 @@
<dt>fattrib</dt>
<dd>Indicates the file/directory attribute in combination of <tt>AM_DIR</tt>, <tt>AM_RDO</tt>, <tt>AM_HID</tt>, <tt>AM_SYS</tt> and <tt>AM_ARC</tt>.</dd>
<dt>fname[]</dt>
-<dd>Indicates the file/directory name in 8.3 format null-terminated string. It is always returnd with upper case in non-LFN configuration but it can be returned with lower case in LFN configuration.</dd>
-<dt>lfname</dt>
-<dd>Pointer to the LFN buffer to store the read LFN. This member must be initialized by application program prior to use this structure. Set a null pointer if LFN is not needed. Not available at non-LFN configuration.</dd>
-<dt>lfsize</dt>
-<dd>Size of the LFN buffer in unit of TCHAR. This member must be initialized by application program prior to use this structure. Not available at non-LFN configuration.</dd>
+<dd>The null-terminated object name is stored. A null string is stored when no item to read and it indicates this structure is invalid.</dd>
+<dt>altname[]</dt>
+<dd>Alternative object name is stored if available. This member is not available at non-LFN configuration.</dd>
</dl>
<p class="foot"><a href="../00index_e.html">Return</a></p>