Symbols

loading...

Files

loading...

Summary Syntax Arguments References Override Tree

SourceVuESP-IDF Framework and ExamplesESP-IDFnvs::NVSHandle::find_key()

nvs::NVSHandle::find_key() method

Checks whether key exists and optionally returns also data type of associated entry.

Syntax

Show:

Summary

Declaration

from nvs_handle.hpp:195

virtual esp_err_t find_key(const char* key, nvs_type_t &nvstype) = 0;

Arguments

Argument

Description

key

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

nvstype

Nvs data type to of entry, if it exists.

Return value

- ESP_OK if NVS entry for key provided was found. Data type will be returned via \c nvstype. - 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.

References

Code

Location

Scope

Referrer

virtual esp_err_t find_key(const char* key, nvs_type_t &nvstype) = 0;

nvs_handle.hpp:195

esp_err_t find_key(const char* key, nvs_type_t &nvstype) override;

nvs_handle_locked.hpp:44

nvs::NVSHandleLocked

nvs::NVSHandleLocked::find_key()

esp_err_t find_key(const char *key, nvs_type_t &nvstype) override;

nvs_handle_simple.hpp:54

nvs::NVSHandleSimple

nvs::NVSHandleSimple::find_key()

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

All items filtered out

All items filtered out

Override Tree

nvs::NVSHandle::find_key() overrides 2 methodss:

nvs::NVSHandleSimple::find_key()

nvs::NVSHandleLocked::find_key()

nvs::NVSHandle::find_key()

Implementations

All items filtered out

All items filtered out

Instances

Lifecycle

All items filtered out

All items filtered out