xTaskGetIdleTaskHandle() function

xTaskGetIdleTaskHandle() is only available if INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h. Simply returns the handle of the idle task. It is not valid to call xTaskGetIdleTaskHandle() before the scheduler has been started.

Syntax

Show:

Summary

Declaration

Definition

from task.h:1542

TaskHandle_t xTaskGetIdleTaskHandle( void ) PRIVILEGED_FUNCTION;

Implemented in tasks.c:2579

References

Code

Location

Referrer

TaskHandle_t xTaskGetIdleTaskHandle( void )

tasks.c:2579

TaskHandle_t xTaskGetIdleTaskHandle( void ) PRIVILEGED_FUNCTION;

task.h:1542

xReturn = xTaskGetIdleTaskHandle();

mpu_wrappers.c:250

MPU_xTaskGetIdleTaskHandle()

Call Tree

xTaskGetIdleTaskHandle() is called by 1 function and calls 1 function:

MPU_xTaskGetIdleTaskHandle()

xTaskGetIdleTaskHandle()

vPortRaiseBASEPRI()

Data Use

xTaskGetIdleTaskHandle() reads 1 variable:

xIdleTaskHandle

xTaskGetIdleTaskHandle()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out

xTaskGetIdleTaskHandle() function

Syntax

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle