Function esp_idf_sys::eTaskGetState

source ·
pub unsafe extern "C" fn eTaskGetState(
    xTask: TaskHandle_t
) -> eTaskState
Expand description

@cond !DOC_EXCLUDE_HEADER_SECTION task. h @code{c} eTaskState eTaskGetState( TaskHandle_t xTask ); @endcode @endcond

INCLUDE_eTaskGetState must be defined as 1 for this function to be available. See the configuration section for more information.

Obtain the state of any task. States are encoded by the eTaskState enumerated type.

@param xTask Handle of the task to be queried.

@return The state of xTask at the time the function was called. Note the state of the task might change between the function being called, and the functions return value being tested by the calling task.