Function esp_idf_sys::xTaskGetHandle

source ·

pub unsafe extern "C" fn xTaskGetHandle(
    pcNameToQuery: *const c_char
) -> TaskHandle_t

Expand description

@cond !DOC_EXCLUDE_HEADER_SECTION task. h @code{c} TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ); @endcode @endcond

NOTE: This function takes a relatively long time to complete and should be used sparingly.

@return The handle of the task that has the human readable name pcNameToQuery. NULL is returned if no matching name is found. INCLUDE_xTaskGetHandle must be set to 1 in FreeRTOSConfig.h for pcTaskGetHandle() to be available.

@cond !DOC_SINGLE_GROUP \defgroup pcTaskGetHandle pcTaskGetHandle @endcond \ingroup TaskUtils