FS_RewindDir

Syntax

#include <nitro/fs.h>

BOOL FS_RewindDir( FSFile *p_dir );

Arguments

p_dir Address of the FSFile structure.

Return Values

Returns TRUE if the directory list correctly returns to the beginning; FALSE otherwise.

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

2004/09/24 Added the description in the Caution section 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