FS_TellDir

Syntax

#include <nitro/fs.h>

BOOL FS_TellDir( const FSFile *p_dir, FSDirPos *p_pos );

Arguments

p_dir	Address of the `FSFile` structure.
p_pos	The address of the structure that stores the directory position.

Return Values

Stores the value of FSDirPos, which indicates the current location. Always returns TRUE.

Description

This acquires the list position that is currently maintained in the specified directory list as FSDirPos. If you use this value when you call the FS_SeekDir function, you will be able to reproduce the current list position.

Revision History

2008/09/26 Revised the return value description to always indicate TRUE.
2004/05/14 Revised the description due to changes to FSDirPos.
2004/04/08 Revised the description due to integration of FSDir and FSFile.
2004/04/01 Initial version.