nvs_find_key() function

Lookup key-value pair with given key name. Note that function may indicate both existence of the key as well as the data type of NVS entry if it is found.

Syntax

Show:

Summary

Declaration

Definition

from nvs.h:521

esp_err_t nvs_find_key(nvs_handle_t handle, const char* key, nvs_type_t* out_type);

Implemented in nvs_api.cpp:310

Arguments

Argument

Description

handle

Storage handle obtained with nvs_open.

key

Key name. Maximum length is (NVS_KEY_NAME_MAX_SIZE-1) characters. Shouldn't be empty.

out_type

Pointer to the output variable populated with data type of NVS entry in case key was found. May be NULL, respective data type is then not provided.

Return value

- ESP_OK if NVS entry for key provided was found - ESP_ERR_NVS_NOT_FOUND if the requested key doesn't exist - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL - ESP_FAIL if there is an internal error; most likely due to corrupted NVS partition (only if NVS assertion checks are disabled) - other error codes from the underlying storage driver

Examples

References

from examples

nvs_find_key() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle