FS_RewindDir

C Specification

#include <nitro/fs.h>

BOOL FS_RewindDir( FSFile *p_dir );

Arguments

p_dir Address of the FSFile structure

Return Values

If the directory list correctly returns to the beginning, it returns a value of TRUE. Otherwise it returns a value of FALSE.

Description

This function returns the list position that is currently maintained in the specified directory list. This function is equivalent to prestoring the value of FSDirPos that indicates the beginning position and using that when calling the FS_SeekDir function.

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, FSDirPos, FS_SeekDir, FS_TellDir

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