nvs_get_stats() function

Fill structure nvs_stats_t. It provides info about memory used by NVS. This function calculates the number of used entries, free entries, available entries, total entries and number of namespaces in partition.

{c}
 // Example of nvs_get_stats() to get overview of actual statistics of data entries :
 nvs_stats_t nvs_stats;
 nvs_get_stats(NULL, &nvs_stats);
 printf("Count: UsedEntries = (%lu), FreeEntries = (%lu), AvailableEntries = (%lu), AllEntries = (%lu)\n",
          nvs_stats.used_entries, nvs_stats.free_entries, nvs_stats.available_entries, nvs_stats.total_entries);
 

Syntax

Show:

Summary

Declaration

Definition

from nvs.h:636

esp_err_t nvs_get_stats(const char *part_name, nvs_stats_t *nvs_stats);

Implemented in nvs_api.cpp:539

Arguments

Argument

Description

part_name

Partition name NVS in the partition table. If pass a NULL than will use NVS_DEFAULT_PART_NAME ("nvs").

nvs_stats

Returns filled structure nvs_states_t. It provides info about used memory the partition.

Return value

- ESP_OK if the changes have been written successfully. Return param nvs_stats will be filled. - ESP_ERR_NVS_PART_NOT_FOUND if the partition with label "name" is not found. Return param nvs_stats will be filled 0. - ESP_ERR_NVS_NOT_INITIALIZED if the storage driver is not initialized. Return param nvs_stats will be filled 0. - ESP_ERR_INVALID_ARG if nvs_stats is equal to NULL. - ESP_ERR_INVALID_STATE if there is page with the status of INVALID. Return param nvs_stats will be filled not with correct values because not all pages will be counted. Counting will be interrupted at the first INVALID page.

Examples

References

from examples

nvs_get_stats() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle