Atmel Software Framework

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages



unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask );

INCLUDE_xTaskPriorityGet must be defined as 1 for this function to be available. See the configuration section for more information.

Obtain the priority of any task.

pxTaskHandle of the task to be queried. Passing a NULL handle results in the priority of the calling task being returned.
The priority of pxTask.

Example usage:

 void vAFunction( void )
 xTaskHandle xHandle;
Create a task, storing the handle.
     xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );
Use the handle to obtain the priority of the created task.
It was created with tskIDLE_PRIORITY, but may have changed
it itself.
     if( uxTaskPriorityGet( xHandle ) != tskIDLE_PRIORITY )
The task has changed it's priority.
Is our priority higher than the created task?
     if( uxTaskPriorityGet( xHandle ) < uxTaskPriorityGet( NULL ) )
Our priority (obtained using NULL handle) is higher.