esp_vfs_fat_sdcard_format() function

Format FAT filesystem

Syntax

Show:

Summary

Declaration

Definition

from esp_vfs_fat.h:268

esp_err_t esp_vfs_fat_sdcard_format(const char *base_path, sdmmc_card_t *card);

Implemented in vfs_fat_sdmmc.c:532

Arguments

Argument

Declared as

Description

base_path

const char *

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

card

sdmmc_card_t *

Pointer to the card handle, which should be initialised by calling `esp_vfs_fat_sdspi_mount` first

Return value

- ESP_OK - ESP_ERR_INVALID_STATE: FAT partition isn't mounted, call esp_vfs_fat_sdmmc_mount or esp_vfs_fat_sdspi_mount first - ESP_ERR_NO_MEM: if memory can not be allocated - ESP_FAIL: fail to format it, or fail to mount back

Notes

This API should be only called when the FAT is already mounted.

References

Code

Location

esp_err_t esp_vfs_fat_sdcard_format(const char *base_path, sdmmc_card_t *card) {

vfs_fat_sdmmc.c:532

esp_err_t esp_vfs_fat_sdcard_format(const char *base_path, sdmmc_card_t *card);

esp_vfs_fat.h:268

Call Tree

esp_vfs_fat_sdcard_format() calls 1 function:

esp_vfs_fat_sdcard_format()

esp_vfs_fat_sdcard_format_cfg()

Data Use

esp_vfs_fat_sdcard_format():

esp_vfs_fat_sdcard_format()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out