nvs_erase_all() function

Erase all key-value pairs in a namespace Note that actual storage may not be updated until nvs_commit function is called.

Syntax

Show:

Summary

Declaration

Definition

from nvs.h:560

esp_err_t nvs_erase_all(nvs_handle_t handle);

Implemented in nvs_api.cpp:342

Arguments

Argument

Description

handle

Storage handle obtained with nvs_open. Handles that were opened read only cannot be used.

Return value

- ESP_OK if erase operation was successful - ESP_FAIL if there is an internal error; most likely due to corrupted NVS partition (only if NVS assertion checks are disabled) - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL - ESP_ERR_NVS_READ_ONLY if handle was opened as read only - other error codes from the underlying storage driver

Examples

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

References

from examples

nvs_erase_all() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle