nvs_flash_erase_partition() function

Erase specified NVS partition Erase all content of a specified NVS partition

Syntax

Show:

Summary

Declaration

Definition

from nvs_flash.h:165

esp_err_t nvs_flash_erase_partition(const char *part_name);

Implemented in nvs_api.cpp:180

Arguments

Argument

Description

part_name

Name (label) of the partition which should be erased

Return value

- ESP_OK on success - ESP_ERR_NOT_FOUND if there is no NVS partition with the specified name in the partition table - different error in case de-initialization fails (shouldn't happen)

Notes

If the partition is initialized, this function first de-initializes it. Afterwards, the partition has to be initialized again to be used.

Examples

nvs_flash_erase_partition() is referenced by 2 libraries and example projects:

References

from examples

nvs_flash_erase_partition() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle