Function esp_idf_svc::sys::esp_ota_get_partition_description

source · 
pub unsafe extern "C" fn esp_ota_get_partition_description(
    partition: *const esp_partition_t,
    app_desc: *mut esp_app_desc_t,
) -> i32
Expand description

@brief Returns esp_app_desc structure for app partition. This structure includes app version.

Returns a description for the requested app partition. @param[in] partition Pointer to app partition. (only app partition) @param[out] app_desc Structure of info about app. @return

  • ESP_OK Successful.
  • ESP_ERR_NOT_FOUND app_desc structure is not found. Magic word is incorrect.
  • ESP_ERR_NOT_SUPPORTED Partition is not application.
  • ESP_ERR_INVALID_ARG Arguments is NULL or if partition’s offset exceeds partition size.
  • ESP_ERR_INVALID_SIZE Read would go out of bounds of the partition.
  • or one of error codes from lower-level flash driver.