fs_dirent_name

int fs_dirent_name(const struct fs_dirent *dirent, size_t max_len,
                   char *out_name, uint8_t *out_name_len)

Retrieves the filename of the specified directory entry.

Arguments

Argument	Description
dirent	Pointer to the directory entry to query
max_len	Size of the “out_name” character buffer
out_name	On success, the entry's filename is written here; always null-terminated
out_name_len	On success, contains the actual length of the filename, NOT including the null-terminator

Returned values

• 0 on success
• FS error code on failure

Notes

The retrieved filename is always null-terminated. To ensure enough space to hold the full filename plus a null-termintor, a destination buffer of size filename-max-length + 1 should be used.

Header file

#include "fs/fs.h"

Example

This example iterates through the contents of a directory, printing the name of each child node. When the traversal is complete, the code closes the directory handle.

int
traverse_dir(const char *dirname)
{
    struct fs_dirent *dirent;
    struct fs_dir *dir;
    char buf[64];
    uint8_t name_len;
    int rc;

    rc = fs_opendir(dirname, &dir);
    if (rc != 0) {
        return -1;
    }

    /* Iterate through the parent directory, printing the name of each child
     * entry.  The loop only terminates via a function return.
     */
    while (1) {
        /* Retrieve the next child node. */
        rc = fs_readdir(dir, &dirent); 
        if (rc == FS_ENOENT) {
            /* Traversal complete. */
            return 0;
        } else if (rc != 0) {
            /* Unexpected error. */
            return -1;
        }

        /* Read the child node's name from the file system. */
        rc = fs_dirent_name(dirent, sizeof buf, buf, &name_len);
        if (rc != 0) {
            return -1;
        }

        /* Print the child node's name to the console. */
        if (fs_dirent_is_dir(dirent)) {
            console_printf(" dir: ");
        } else {
            console_printf("file: ");
        }
        console_printf("%s\n", buf);
    }
}