Function esp_idf_hal::sys::uxTaskGetSnapshotAll

source · 
pub unsafe extern "C" fn uxTaskGetSnapshotAll(
    pxTaskSnapshotArray: *mut xTASK_SNAPSHOT,
    uxArrayLength: u32,
    pxTCBSize: *mut u32,
) -> u32
Expand description

@brief Fill an array of TaskSnapshot_t structures for every task in the system

  • This function is used by the panic handler to get a snapshot of all tasks in the system
  • 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[out] pxTaskSnapshotArray Array of TaskSnapshot_t structures filled by this function @param[in] uxArrayLength Length of the provided array @param[out] pxTCBSize Size of the a task’s TCB structure @return UBaseType_t