Main Page | Modules | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

Directory Access
[FILE - Class for file management]


Functions

FDIR otFILE.dnew ()
void otFILE.dend (FDIR d)
bool otFILE.dopen (FDIR dir, const char *path)
bool otFILE.dread (FDIR dir, FINF fno)
bool otFILE.dfindfirst (FDIR dir, FINF fno, const char *path, const char *pattern)
bool otFILE.dfindnext (FDIR dir, FINF fno)
bool otFILE.dclose (FDIR dir)

Function Documentation

bool otFILE.dclose (  FDIR  dir  )  [inherited]
 

Function closes an open directory.

Parameters:
dir Pointer to the open directory object structure to be closed.
Returns:
True on success

void otFILE.dend (  FDIR  d  )  [inherited]
 

Free a DIR data structure

Parameters:
d DIR data structure to be freed

bool otFILE.dfindfirst (  FDIR  dir,
FINF  fno,
const char *  path,
const char *  pattern
)  [inherited]
 

Function searches a directroy for an item.

Parameters:
dir Pointer to the blank directory object.
fno Pointer to the file information structure to store the information about the found item.
path Pointer to the null-terminated string that specifies the directory name to be opened.
pattern Pointer to the nul-terminated string that specifies the name matching pattern to be searched for. It is referred by also subsequent dfindnext function, so that the string must be valid while the successive function calls.
Returns:
True on success

bool otFILE.dfindnext (  FDIR  dir,
FINF  fno
)  [inherited]
 

Function searches for a next matched object

Parameters:
dir Pointer to the valid directory object created by dfindfirst function.
fno Pointer to the file information structure to store the information about the found directory item.
Returns:
True on success

FDIR otFILE.dnew (   )  [inherited]
 

Create a DIR data structure

Returns:
DIR data structure

bool otFILE.dopen (  FDIR  dir,
const char *  path
)  [inherited]
 

Function opens a directory.

Parameters:
dir Pointer to the blank directory object to create a new one.
path Pointer to the null-terminated string that specifies the directory name to be opened.
Returns:
True on success

bool otFILE.dread (  FDIR  dir,
FINF  fno
)  [inherited]
 

Function reads an item of the directory.

Parameters:
dir Pointer to the open directory object.
fno Pointer to the file information structure to store the information about read item. A null pointer rewinds the read index of the directory.
Returns:
True on success
footer

otStudio - Library Reference - (C) 2020-25 Officina Turini, All Rights Reserved
Document built with Doxygen 1.4.0