X-Git-Url: http://cloudbase.mooo.com/gitweb/z180-stamp.git/blobdiff_plain/b4e3fab85fcd9f5b1502ec991c81302b910492d3:/fatfs/doc/en/readdir.html..0f3b947bda5f34662a611272b9f12199e0da9aca:/fatfs/documents/doc/readdir.html diff --git a/fatfs/doc/en/readdir.html b/fatfs/documents/doc/readdir.html similarity index 71% rename from fatfs/doc/en/readdir.html rename to fatfs/documents/doc/readdir.html index 235beee..878cb02 100644 --- a/fatfs/doc/en/readdir.html +++ b/fatfs/documents/doc/readdir.html @@ -1,7 +1,7 @@ - + @@ -26,9 +26,9 @@ FRESULT f_readdir (

Parameters

dp
-
Pointer to the open directory object or null pointer.
+
Pointer to the open directory object.
fno
-
Pointer to the file information structure to store the information about read item.
+
Pointer to the file information structure to store the information about read item. A null pointer rewinds the read index of the directory.
@@ -49,19 +49,20 @@ FRESULT f_readdir (

Description

The f_readdir function reads a directory item, informations about the object. All items in the directory can be read in sequence by f_readdir function calls. Dot entries ("." and "..") in the sub-directory are filtered out and they will never appear in the read items. When all directory items have been read and no item to read, a nul string is stored into the fno->fname[] without any error. When a null pointer is given to the fno, the read index of the directory object is rewinded.

-

When support of long file name (LFN) is enabled, a member altname[] is defined in the file information structure to store the short file name of the object. In case of the some conditions listed below, short file name is stored into the fname[] and altname[] has a null string.

+

When support of long file name (LFN) is enabled, a member altname[] is defined in the file information structure to store the short file name of the object. If the long file name is not accessible due to some reason listed below, short file name is stored to the fname[] and altname[] has a null string.

-

There is a problem on reading a directory of exFAT volume. The exFAT does not support short file name. This means no name can be returned on the condition above. If it is the case, a "?" is returned as file name to indicate that the object is not accessible. To avoid this problem, configure FatFs _LFN_UNICODE = 1 and _MAX_LFN = 255 to support the full feature of LFN specification.

+

There is a problem on reading a directory of exFAT volume. The exFAT does not support short file name. This means no name can be returned on the condition above. If it is the case, "?" is returned into the fname[] to indicate that the object is not accessible. To avoid this problem, configure FatFs FF_LFN_UNICODE >= 1 and FF_MAX_LFN == 255 to support the full feature of LFN specification.

QuickInfo

-

Available when _FS_MINIMIZE <= 1.

+

Available when FF_FS_MINIMIZE <= 1.

@@ -81,7 +82,7 @@ FRESULT scan_files ( res = f_opendir(&dir, path); /* Open the directory */ if (res == FR_OK) { for (;;) { - res = f_readdir(&dir, &fno); /* Read a directory item */ + res = f_readdir(&dir, &fno); /* Read a directory item */ if (res != FR_OK || fno.fname[0] == 0) break; /* Break on error or end of dir */ if (fno.fattrib & AM_DIR) { /* It is a directory */ i = strlen(path);