X-Git-Url: http://cloudbase.mooo.com/gitweb/z180-stamp.git/blobdiff_plain/5366852335044c1e68a5c32548d3051cc943552f..refs/tags/fatfs-0.12b:/fatfs/doc/en/sfileinfo.html
diff --git a/fatfs/doc/en/sfileinfo.html b/fatfs/doc/en/sfileinfo.html
index 5674086..6dae1fe 100644
--- a/fatfs/doc/en/sfileinfo.html
+++ b/fatfs/doc/en/sfileinfo.html
@@ -13,17 +13,18 @@
FILINFO
-
The FILINFO structure holds a file information returned by f_readdir() and f_stat() function.
+
The FILINFO structure holds information about the object returned by f_readdir, f_findfirst, f_findnext and f_stat function.
typedef struct {
- DWORD fsize; /* File size */
- WORD fdate; /* Last modified date */
- WORD ftime; /* Last modified time */
- BYTE fattrib; /* Attribute */
- TCHAR fname[13]; /* Short file name (8.3 format) */
-#if _USE_LFN
- TCHAR* lfname; /* Pointer to the LFN buffer */
- int lfsize; /* Size of the LFN buffer in unit of TCHAR */
+ FSIZE_t fsize; /* File size */
+ WORD fdate; /* Last modified date */
+ WORD ftime; /* Last modified time */
+ BYTE fattrib; /* Attribute */
+#if _USE_LFN != 0
+ TCHAR altname[13]; /* Alternative object name */
+ TCHAR fname[_MAX_LFN + 1]; /* Primary object name */
+#else
+ TCHAR fname[13]; /* Object name */
#endif
} FILINFO;
@@ -32,9 +33,9 @@
Members
- fsize
-- Indicates size of the file in unit of byte. Always zero for directories.
+- Indicates size of the file in unit of byte. FSIZE_t is an alias of integer type either DWORD(32-bit) or QWORD(64-bit) depends on the configuration option _FS_EXFAT. Do not care when the item is a directory.
- fdate
-- Indicates the date that the file was modified or the directory was created.
+- Indicates the date when the file was modified or the directory was created.
- bit15:9
- Year origin from 1980 (0..127)
@@ -45,7 +46,7 @@
- ftime
-- Indicates the time that the file was modified or the directory was created.
+- Indicates the time when the file was modified or the directory was created.
- bit15:11
- Hour (0..23)
@@ -58,11 +59,9 @@
- fattrib
- Indicates the file/directory attribute in combination of AM_DIR, AM_RDO, AM_HID, AM_SYS and AM_ARC.
- fname[]
-- 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.
-- lfname
-- Pointer to the LFN buffer to store the read LFN. This member must be initialized by application prior to use this structure. Set null pointer if LFN is not needed. Not available in non-LFN configuration.
-- lfsize
-- Size of the LFN buffer in unit of TCHAR. This member must be initialized by application prior to use this structure. Not available in non-LFN configuration.
+- The null-terminated object name is stored. A null string is stored when no item to read and it indicates this structure is invalid.
+- altname[]
+- Alternative object name is stored if available. This member is not available at non-LFN configuration.