SourceVuESP-IDF Framework and ExamplesESP-IDFnvs_set_blob()

nvs_set_blob() function

set variable length binary value for given key Sets variable length binary value for the key. Function uses 2 overhead and 1 entry per each 32 bytes of new data from the pool of available entries. See \c nvs_get_stats . In case of value update for existing key, space occupied by the existing value and 2 overhead entries are returned to the pool of available entries. Note that the underlying storage will not be updated until \c nvs_commit is called.

Syntax

Show:

Summary

Declaration

Definition

from nvs.h:346

esp_err_t nvs_set_blob(nvs_handle_t handle, const char* key, const void* value, size_t length);

Implemented in nvs_api.cpp:433

Arguments

Argument

Declared as

Description

handle

nvs_handle_t

Handle obtained from nvs_open function. Handles that were opened read only cannot be used.

key

const char*

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

value

const void*

The value to set.

length

size_t

length of binary value to set, in bytes; Maximum length is 508000 bytes or (97.6% of the partition size - 4000) bytes whichever is lower.

Return value

- ESP_OK if value was set successfully - ESP_FAIL if there is an internal error; most likely due to corrupted NVS partition (only if NVS assertion checks are disabled) - ESP_ERR_NVS_INVALID_HANDLE if handle has been closed or is NULL - ESP_ERR_NVS_READ_ONLY if storage handle was opened as read only - ESP_ERR_NVS_INVALID_NAME if key name doesn't satisfy constraints - ESP_ERR_NVS_NOT_ENOUGH_SPACE if there is not enough space in the underlying storage to save the value - ESP_ERR_NVS_REMOVE_FAILED if the value wasn't updated because flash write operation has failed. The value was written however, and update will be finished after re-initialization of nvs, provided that flash operation doesn't fail again. - ESP_ERR_NVS_VALUE_TOO_LONG if the value is too long

Examples

nvs_set_blob() is referenced by 8 libraries and example projects:

References

from examples

nvs_set_blob() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle