Skip to end of metadata
Go to start of metadata

Description

Read a directory entry from a directory table.

Files

fs_core_dir.h/fs_core_dir.c

Prototype

 

CPU_BOOLEAN  FSDir_Rd (FS_DIR_HANDLE   dir_handle,
FS_ENTRY_INFO *p_entry_info,
CPU_CHAR *p_buf,
CPU_SIZE_T buf_size,
RTOS_ERR *p_err)

 

Arguments

dir_handle

Handle to a directory.

p_entry_info

Pointer to a structure that will receive the entry information.

p_buf

Pointer to a buffer that will receive the entry name.

buf_size

Size of the given buffer.

p_err

Pointer to variable that will receive the return error code(s) from this function:

RTOS_ERR_NONE
RTOS_ERR_WOULD_OVF
RTOS_ERR_ENTRY_CLOSED
RTOS_ERR_VOL_CLOSED
RTOS_ERR_VOL_CORRUPTED
RTOS_ERR_BLK_DEV_CLOSED
RTOS_ERR_BLK_DEV_CORRUPTED
RTOS_ERR_IO

Returned Value

DEF_NO, if there are other available entries.
DEF_YES, if there are no more entry.

Notes / Warnings

(1) Entries for "dot" (current directory) and "dot-dot" (parent directory) will be returned, if present.

(2) A subsequent call to FSDir_Rd() will return the next directory entry in the table until there is no more entry to read. 

  • No labels