esp_vfs_fat_register_cfg() function

Register FATFS with VFS component This function registers given FAT drive in VFS, at the specified base path. Input arguments are held in esp_vfs_fat_conf_t structure. If only one drive is used, fat_drive argument can be an empty string. Refer to FATFS library documentation on how to specify FAT drive. This function also allocates FATFS structure which should be used for f_mount call.

Syntax

Show:

Summary

Declaration

Definition

from esp_vfs_fat.h:49

esp_err_t esp_vfs_fat_register_cfg(const esp_vfs_fat_conf_t* conf, FATFS** out_fs);

Implemented in vfs_fat.c:181

Arguments

Argument

Description

conf

pointer to esp_vfs_fat_conf_t configuration structure

out_fs

pointer to FATFS structure which can be used for FATFS f_mount call is returned via this argument.

Return value

- ESP_OK on success - ESP_ERR_INVALID_STATE if esp_vfs_fat_register was already called - ESP_ERR_NO_MEM if not enough memory or too many VFSes already registered

Notes

This function doesn't mount the drive into FATFS, it just connects POSIX and C standard library IO function with FATFS. You need to mount desired drive into FATFS separately.

Examples

References

from examples

esp_vfs_fat_register_cfg() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle