Quality RTOS & Embedded Software

  Real time embedded FreeRTOS RSS feed  

pvTaskGetThreadLocalStoragePointer
[Task Utilities]

task. h
void *pvTaskGetThreadLocalStoragePointer(
                                 TaskHandle_t xTaskToQuery,
                                 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.



Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.