fs_readdir_r()

int  fs_readdir (FS_DIR            *p_dir,
                 struct fs_dirent  *p_dir_entry,
                 struct fs_dirent **pp_result);

File

Called from

Code enabled by

fs_api.c

Application

FS_CFG_API_EN and FS_CFG_DIR_EN

Read a directory entry from a directory.

Arguments

p_dir

Pointer to a directory.

p_dir_entry

Pointer to variable that will receive directory entry information.

pp_result

Pointer to variable that will receive:

    • p_dir_entry, if NO error occurs AND directory does not encounter EOF.
    • pointer to NULL if an error occurs OR directory encounters EOF.

Returned Value

1, if an error occurs.
0, otherwise.

Notes/Warnings

  1. Entries for “dot” (current directory) and “dot-dot” (parent directory) shall be returned, if present. No entry with an empty name shall be returned.
  2. If an entry is removed from or added to the directory after the directory has been opened, information may or may not be returned for that entry.