]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/documents/doc/sfileinfo.html
Import fatfs R0.13b
[z180-stamp.git] / fatfs / documents / doc / sfileinfo.html
similarity index 61%
rename from fatfs/doc/en/sfileinfo.html
rename to fatfs/documents/doc/sfileinfo.html
index 6dae1fe33fb03327f49766d642629534f9917124..b4c906364d02ffc11373e206d329545c29012246 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r
 <html lang="en">\r
 <head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r
 <meta http-equiv="Content-Style-Type" content="text/css">\r
 <link rel="up" title="FatFs" href="../00index_e.html">\r
 <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/sfileinfo.html">\r
 \r
 <div class="para">\r
 <h2>FILINFO</h2>\r
-<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>\r
+<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. Be careful in the size of structure when LFN is enabled.</p>\r
 <pre>\r
 <span class="k">typedef struct</span> {\r
     FSIZE_t fsize;               <span class="c">/* File size */</span>\r
     WORD    fdate;               <span class="c">/* Last modified date */</span>\r
     WORD    ftime;               <span class="c">/* Last modified time */</span>\r
     BYTE    fattrib;             <span class="c">/* Attribute */</span>\r
-<span class="k">#if</span> _USE_LFN != 0\r
-    TCHAR   altname[13];         <span class="c">/* Alternative object name */</span>\r
-    TCHAR   fname[_MAX_LFN + 1]; <span class="c">/* Primary object name */</span>\r
+<span class="k">#if</span> FF_USE_LFN\r
+    TCHAR   altname[FF_SFN_BUF + 1]; <span class="c">/* Alternative object name */</span>\r
+    TCHAR   fname[FF_LFN_BUF + 1];   <span class="c">/* Primary object name */</span>\r
 <span class="k">#else</span>\r
-    TCHAR   fname[13];           <span class="c">/* Object name */</span>\r
+    TCHAR   fname[12 + 1];       <span class="c">/* Object name */</span>\r
 <span class="k">#endif</span>\r
 } FILINFO;\r
 </pre>\r
@@ -33,7 +33,7 @@
 <h4>Members</h4>\r
 <dl>\r
 <dt>fsize</dt>\r
-<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>\r
+<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>FF_FS_EXFAT</tt>. Do not care when the item is a directory.</dd>\r
 <dt>fdate</dt>\r
 <dd>Indicates the date when the file was modified or the directory was created.<br>\r
 <dl>\r
 </dl>\r
 </dd>\r
 <dt>fattrib</dt>\r
-<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>\r
+<dd>Indicates the attribute flags in combination of:<br>\r
+<table class="lst">\r
+<tr><th>Flag</th><th>Meaning</th></tr>\r
+<tr><td>AM_RDO</td><td>Read-only. Write mode open and deleting is rejected.</td></tr>\r
+<tr><td>AM_HID</td><td>Hidden. Should not be shown in normal directory listing.</td></tr>\r
+<tr><td>AM_SYS</td><td>System. Used by system and should not be accessed.</td></tr>\r
+<tr><td>AM_ARC</td><td>Archive. Set on new creation or any modification to the file.</td></tr>\r
+<tr><td>AM_DIR</td><td>Directory. This is not a file but a sub-directory container.</td></tr>\r
+</table>\r
+</dd>\r
 <dt>fname[]</dt>\r
-<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>\r
+<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. The size of <tt>fname[]</tt> and <tt>altname[]</tt> each can be configured at LFN configuration.</dd>\r
 <dt>altname[]</dt>\r
 <dd>Alternative object name is stored if available. This member is not available at non-LFN configuration.</dd>\r
 </dl>\r