FS_ReadDir

Syntax

#include <nitro/fs.h>

BOOL FS_ReadDir( FSFile *p_dir, FSDirEntry *p_entry );

Arguments

p_dir Address of the FSFile structure.
p_entry Address of the FSDirEntry structure.

Return Values

If there is a remaining directory entry, this function gets the remaining directory entry and returns TRUE.
If this function arrives at the end of the directory list, it returns FALSE.

Description

Gets the next directory entry from the specified directory list. Each time the next directory entry is acquired, the directory list position is incremented by one. When the directory list arrives at the end, this function returns FALSE starting with the next call.
For example, if you use the FS_FindDir function to open a directory containing three files and then call that directory using this function, this function returns TRUE three times and FALSE the fourth time.

Use the FS_ReadDirectory function to get detailed information such as update times and file attributes such as NAND Archives and SD memory card Archives.

Note

This function cannot be called from the interrupt handler (IRQ mode).
Also note that in some cases processing may not end if interrupts are left prohibited.


See Also

FSFile
FSDirEntry
FS_FindDir
FS_TellDir
FS_SeekDir
FS_RewindDir
FS_ReadDirectory

Revision History

2009/07/16 Added description of explanation related to FS_ReadDirectory.
2009/07/16 Updated part of See Also.
2004/09/24 Added the description in Note regarding the conditions for calling this function.
2004/04/08 Revised description due to the integration of FSDir and FSFile.
2004/04/01 Initial version.


CONFIDENTIAL