esp_vfs_fat_spiflash_format_cfg_rw_wl() function

Format FAT filesystem with given configuration

Syntax

Show:

Summary

Declaration

Definition

from esp_vfs_fat.h:332

esp_err_t esp_vfs_fat_spiflash_format_cfg_rw_wl(const char* base_path, const char* partition_label, esp_vfs_fat_mount_config_t *cfg);

Implemented in vfs_fat_spiflash.c:231

Arguments

Argument

Description

base_path

Path where partition should be registered (e.g. "/spiflash")

partition_label

Label of the partition which should be used

cfg

Pointer to structure with extra parameters for formatting FATFS (only relevant fields are used). If NULL and mounted the previous configuration will be used. If NULL and unmounted the default configuration will be used.

Return value

- ESP_OK - ESP_ERR_NO_MEM: if memory can not be allocated - Other errors from esp_vfs_fat_spiflash_mount_rw_wl

Notes

This API can be called when the FAT is mounted / not mounted. If this API is called when the FAT isn't mounted (by calling esp_vfs_fat_spiflash_mount_rw_wl), this API will first mount the FAT then format it, then restore back to the original state.

Examples

References

from examples

esp_vfs_fat_spiflash_format_cfg_rw_wl() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle