esp_https_ota_get_img_desc() function

Reads app description from image header. The app description provides information like the "Firmware version" of the image.

Syntax

Show:

Summary

Declaration

Definition

from esp_https_ota.h:224

esp_err_t esp_https_ota_get_img_desc(esp_https_ota_handle_t https_ota_handle, esp_app_desc_t *new_app_info);

Implemented in esp_https_ota.c:452

Arguments

Argument

Declared as

Description

https_ota_handle

esp_https_ota_handle_t

pointer to esp_https_ota_handle_t structure

new_app_info

esp_app_desc_t *

pointer to an allocated esp_app_desc_t structure

Return value

- ESP_ERR_INVALID_ARG: Invalid arguments - ESP_ERR_INVALID_STATE: Invalid state to call this API. esp_https_ota_begin() not called yet. - ESP_FAIL: Failed to read image descriptor - ESP_OK: Successfully read image descriptor

Notes

This API can be called only after esp_https_ota_begin() and before esp_https_ota_perform(). Calling this API is not mandatory.

Examples

esp_https_ota_get_img_desc() is referenced by 1 libraries and example projects:

References

from examples

esp_https_ota_get_img_desc() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle