Updated Mar 2025
pvTaskGetThreadLocalStoragePointer
task. h
1void *pvTaskGetThreadLocalStoragePointer(2 TaskHandle_t xTaskToQuery,3 BaseType_t xIndex );
Retrieves a value from a task's thread local storage array.
This function is intended for advanced users only.
Parameters:
-
xTaskToQuery
The handle of the task from which the thread local data is being read. A task can read its own thread local data by using NULL as the parameter value.
-
xIndex
The index into the thread local storage array from which data is being read.
The number of available array indexes is set by the configNUM_THREAD_LOCAL_STORAGE_POINTERS compile time configuration constant in FreeRTOSConfig.h.
Returns:
The values stored in index position xIndex of the thread local storage array of task xTaskToQuery.
Example usage:
See the examples provided on the thread local storage array documentation page.