mirror of
https://gitee.com/openharmony/third_party_littlefs
synced 2025-02-17 06:08:16 +00:00
Fixed documentation for return lfs_dir_read return value.
lfs_dir_read breaks the convention of returning non-zero on success, this feature should be at least documented.
This commit is contained in:
parent
d3a2cf48d4
commit
26d25608b6
3
lfs.h
3
lfs.h
@ -448,7 +448,8 @@ int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir);
|
||||
// Read an entry in the directory
|
||||
//
|
||||
// Fills out the info structure, based on the specified file or directory.
|
||||
// Returns a negative error code on failure.
|
||||
// Returns a positive value on success, 0 at the end of directory,
|
||||
// or a negative error code on failure.
|
||||
int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info);
|
||||
|
||||
// Change the position of the directory
|
||||
|
Loading…
x
Reference in New Issue
Block a user