Espressif ESP32-S2 User Manual

Chapter 2. API Reference
(continued from previous page)
{
// Our priority (obtained using NULL handle) is higher.
}
}
Return The priority of xTask.
Parameters
• xTask: Handle of the task to be queried. Passing a NULL handle results in the priority of the
calling task being returned.
UBaseType_t uxTaskPriorityGetFromISR(const TaskHandle_t xTask)
A version of uxTaskPriorityGet() that can be used from an ISR.
eTaskState eTaskGetState(TaskHandle_t xTask)
INCLUDE_eTaskGetState must be defined as 1 for this function to be available. See the configuration section
for more information.
Obtain the state of any task. States are encoded by the eTaskState enumerated type.
Return The state of xTask at the time the function was called. Note the state of the task might change between
the function being called, and the functions return value being tested by the calling task.
Parameters
• xTask: Handle of the task to be queried.
void vTaskGetInfo(TaskHandle_t xTask, TaskStatus_t *pxTaskStatus, BaseType_t xGetFreeStackSpace,
eTaskState eState)
configUSE_TRACE_FACILITY must be defined as 1 for this function to be available. See the configuration
section for more information.
Populates a TaskStatus_t structure with information about a task.
Example usage:
void vAFunction( void )
{
TaskHandle_t xHandle;
TaskStatus_t xTaskDetails;
// Obtain the handle of a task from its name.
xHandle = xTaskGetHandle( "Task_Name" );
// Check the handle is not NULL.
configASSERT( xHandle );
// Use the handle to obtain further information about the task.
vTaskGetInfo( xHandle,
&xTaskDetails,
pdTRUE, // Include the high water mark in xTaskDetails.
eInvalid ); // Include the task state in xTaskDetails.
}
Parameters
• xTask: Handle of the task being queried. If xTask is NULL then information will be returned
about the calling task.
• pxTaskStatus: A pointer to the TaskStatus_t structure that will be filled with information about
the task referenced by the handle passed using the xTask parameter.
• xGetFreeStackSpace: The TaskStatus_t structure contains a member to report the stack high
water mark of the task being queried. Calculating the stack high water mark takes a relatively long
time, and can make the system temporarily unresponsive - so the xGetFreeStackSpace parameter is
provided to allow the high water mark checking to be skipped. The high watermark value will only
be written to the TaskStatus_t structure if xGetFreeStackSpace is not set to pdFALSE;
• eState: The TaskStatus_t structure contains a member to report the state of the task being queried.
Obtaining the task state is not as fast as a simple assignment - so the eState parameter is provided to
Espressif Systems 861
Submit Document Feedback
Release v4.4

Espressif ESP32-S2 Specifications

General

Brand	Espressif
Model	ESP32-S2
Category	Single board computers
Language	English