xTaskGetHandle() function

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

Syntax

Show:

Summary

Declaration

Definition

from task.h:1415

TaskHandle_t xTaskGetHandle( const char *pcNameToQuery ) PRIVILEGED_FUNCTION;

Implemented in tasks.c:2440

Arguments

Argument

pcNameToQuery

Return value

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.

Examples

References

from examples

xTaskGetHandle() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle