nvs_flash.h File Reference

#include "nvs.h"
#include "esp_partition.h"

Go to the source code of this file.

Functions
esp_err_t	nvs_flash_init (void)
	Initialize the default NVS partition (label "nvs").
esp_err_t	nvs_flash_init_partition (const char *partition_label)
	Initialize NVS storage for a named partition.
esp_err_t	nvs_flash_init_partition_ptr (const esp_partition_t *partition)
	Initialize NVS storage from an esp_partition_t pointer.
esp_err_t	nvs_flash_deinit (void)
	Deinitialize the default NVS partition.
esp_err_t	nvs_flash_deinit_partition (const char *partition_label)
	Deinitialize NVS storage for a named partition.
esp_err_t	nvs_flash_erase (void)
	Erase the default NVS partition (label "nvs").
esp_err_t	nvs_flash_erase_partition (const char *part_name)
	Erase a named NVS partition.
esp_err_t	nvs_flash_erase_partition_ptr (const esp_partition_t *partition)
	Erase a partition identified by pointer.

Function Documentation

nvs_flash_init()

esp_err_t nvs_flash_init

(

void

)

Initialize the default NVS partition (label "nvs").

nvs_flash_init_partition()

esp_err_t nvs_flash_init_partition

(

const char *

partition_label

)

Initialize NVS storage for a named partition.

Parameters

partition_label

Label of the partition (max 16 chars).

nvs_flash_init_partition_ptr()

esp_err_t nvs_flash_init_partition_ptr

(

const esp_partition_t *

partition

)

Initialize NVS storage from an esp_partition_t pointer.

Parameters

partition

Partition descriptor obtained from esp_partition API.

nvs_flash_deinit()

esp_err_t nvs_flash_deinit

(

void

)

Deinitialize the default NVS partition.

nvs_flash_deinit_partition()

esp_err_t nvs_flash_deinit_partition

(

const char *

partition_label

)

Deinitialize NVS storage for a named partition.

nvs_flash_erase()

esp_err_t nvs_flash_erase

(

void

)

Erase the default NVS partition (label "nvs").

If the partition is initialised, it is first deinitialised.

nvs_flash_erase_partition()

esp_err_t nvs_flash_erase_partition

(

const char *

part_name

)

Erase a named NVS partition.

If the partition is initialised, it is first deinitialised.

nvs_flash_erase_partition_ptr()

esp_err_t nvs_flash_erase_partition_ptr

(

const esp_partition_t *

partition

)

Erase a partition identified by pointer.

If the partition is initialised, it is first deinitialised.