FS_FindDir


C Specification

#include <nitro/fs.h>

BOOL FS_FindDir( FSFile *p_dir, const char *path );

Description

This function opens a directory list using a specified path name. For information on the path name format, see the definition of the FS_OpenFile function.

If you call the FS_ReadDir function using the directory list that was opened, you will be able to sequentially list the file entries in the directory as an FSDirEntry structure.

Caution

This function cannot be called from the interrupt handler (IRQ mode). Note that the process may not be completed if interrupts are prohibited.

Arguments

p_dir Address of the FSFile structure.
path Directory's path name

Return Values

If the directory list is correctly opened it returns TRUE. Otherwise it returns FALSE.

See Also

FSFile, FSDirEntry, FS_ReadDir, FS_TellDir, FS_SeekDir, FS_RewindDir, FS_FILE_NAME_MAX

Revision History

09/24/2004 Added the description in the Caution section regarding the conditions for calling this function.
04/08/2004 Revised description due to the integration of FSDir and FSFile.
04/01/2004 Initial Version