FS_Dir_Api Struct Reference

Data Fields
bool(*const	open )(void *context, File *file, const char *path)
	Dir api structure.
bool(*const	close )(void *context, File *file)
	Close directory.
bool(*const	read )(void *context, File *file, FileInfo *fileinfo, char *name, uint16_t name_length)
	Read next object info in directory.
bool(*const	rewind )(void *context, File *file)
	Rewind to first object info in directory.

Field Documentation

close

bool(*const FS_Dir_Api::close) (void *context, File *file)

Close directory.

Parameters

file	pointer to file object

Returns

success flag

open

bool(*const FS_Dir_Api::open) (void *context, File *file, const char *path)

Dir api structure.

Open directory to get objects from

Parameters

file	pointer to file object, filled by api
path	path to directory

Returns

success flag

read

bool(*const FS_Dir_Api::read) (void *context, File *file, FileInfo *fileinfo, char *name, uint16_t name_length)

Read next object info in directory.

Parameters

file	pointer to file object
fileinfo	pointer to read FileInfo, can be NULL
name	pointer to name buffer, can be NULL
name_length	name buffer length

Returns

success flag (if next object not exist also returns false and set error_id to FSE_NOT_EXIST)

rewind

bool(*const FS_Dir_Api::rewind) (void *context, File *file)

Rewind to first object info in directory.

Parameters

file	pointer to file object

Returns

success flag

---

The documentation for this struct was generated from the following file:

• filesystem_api_internal.h