nvs_bootloader_read_list_t struct

Structure representing one NVS bootloader entry. This structure serves as read operation input parameters and result value and status placeholder. Before calling the `nvs_bootloader_read` function, populate the namespace_name, key_name and value_type members. If string value has to be read, provide also buffer and its length in the `value.str_val` member. The result_code member will be populated by the function with the result of the read operation. There are 2 possible situations and interpretations of the result_code: If the return value of the `nvs_bootloader_read` was ESP_OK, the result_code will be one of the following: - `ESP_OK`: Entry found, value member contains the data. This is the only case when the value member is populated. - `ESP_ERR_NVS_TYPE_MISMATCH`: Entry was found, but requested datatype doesn't match datatype found in NVS - `ESP_ERR_NVS_NOT_FOUND`: Data was not found. - `ESP_ERR_INVALID_SIZE`: the value found for string is longer than the space provided in placeholder (str_val.buff_len) If the return value of the function was ESP_ERR_INVALID_ARG, the result_code will be one of the following: - `ESP_ERR_NVS_NOT_FOUND`: Check of this parameters was successful. - `ESP_ERR_NVS_INVALID_NAME`: namespace_name is NULL or too long - `ESP_ERR_NVS_KEY_TOO_LONG`: key_name NULL or too long - `ESP_ERR_INVALID_SIZE`: the size of the buffer provided for NVS_TYPE_STR in placeholder (str_val.buff_len) is zero or exceeds maximum value NVS_CONST_STR_LEN_MAX_SIZE - `ESP_ERR_INVALID_ARG`: Invalid datatype requested

Syntax

Show:

Summary

Declaration

from nvs_bootloader.h:66

typedef struct { const char* namespace_name; const char* key_name; nvs_type_t value_type; esp_err_t result_code; nvs_bootloader_value_placeholder_t value; uint8_t namespace_index; } nvs_bootloader_read_list_t;