nvs::open_nvs_handle_from_partition() function

Opens non-volatile storage and returns a handle object. The handle is automatically closed on destruction. The scope of the handle is the namespace ns_name in a particular partition partition_name. The parameters partition_name, ns_name and open_mode have the same meaning and restrictions as the parameters part_name, name and open_mode in nvs_open_from_partition, respectively.

Syntax

Show:

Summary

Declaration

Definition

from nvs_handle.hpp:260

std::unique_ptr<NVSHandle> open_nvs_handle_from_partition(const char *partition_name, const char *ns_name, nvs_open_mode_t open_mode, esp_err_t *err = nullptr);

Implemented in nvs_cxx_api.cpp:22

Arguments

Argument

Description

partition_name

ns_name

open_mode

err

an optional pointer to an esp_err_t result of the open operation, having the same meaning as the return value in nvs_open_from_partition: - ESP_OK if storage handle was opened successfully - ESP_ERR_NVS_NOT_INITIALIZED if the storage driver is not initialized - ESP_ERR_NVS_PART_NOT_FOUND if the partition with label "nvs" is not found - ESP_ERR_NVS_NOT_FOUND id namespace doesn't exist yet and mode is NVS_READONLY - ESP_ERR_NVS_INVALID_NAME if namespace name doesn't satisfy constraints - ESP_ERR_NOT_ALLOWED if the NVS partition is read-only and mode is NVS_READWRITE - other error codes from the underlying storage driver