Function esp_idf_hal::sys::vTaskGetSnapshot

source · 
pub unsafe extern "C" fn vTaskGetSnapshot(
    pxTask: *mut tskTaskControlBlock,
    pxTaskSnapshot: *mut xTASK_SNAPSHOT,
) -> i32
Expand description

@brief Fill a TaskSnapshot_t structure for specified task.

  • This function is used by the panic handler to get the snapshot of a particular task.
  • This function is only available when CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT is set to 1.

@note This function should only be called when FreeRTOS is no longer running (e.g., during a panic) as this function does not acquire any locks. @param[in] pxTask Task’s handle @param[out] pxTaskSnapshot Snapshot of the task @return pdTRUE if operation was successful else pdFALSE