TaskHookFunction_t xTaskGetApplicationTaskTag( TaskHandle_t xTask );
configUSE_APPLICATION_TASK_TAG must be defined as 1 for this function to be available.
See the RTOS Configuration documentation for more information.
Returns the ‘tag’ value associated with a task. The meaning and use of the tag
value is defined by the application writer. The RTOS kernel itself will not normally
access the tag value.
This function is intended for advanced users only.
|xTask ||The handle of the task being queried. A task can query its own tag value by using NULL as the parameter value.|
The ‘tag’ value of the task being queried.
/* In this example, an integer is set as the task tag value. */
void vATask( void *pvParameters )
/* Assign a tag value of 1 to the currently executing task.
The (void *) cast is used to prevent compiler warnings. */
vTaskSetApplicationTaskTag( NULL, ( void * ) 1 );
for( ;; )
/* Rest of task code goes here. */
void vAFunction( void )
/* Create a task from the vATask() function, storing the handle to the
created task in the xTask variable. */
/* Create the task. */
vATask, /* Pointer to the function that implements
the task. */
"Demo task", /* Text name given to the task. */
STACK_SIZE, /* The size of the stack that should be created
for the task. This is defined in words, not
NULL, /* The task does not use the
TASK_PRIORITY, /* The priority to assign to the newly created
&xHandle /* The handle to the task being created will be
placed in xHandle. */
) == pdPASS )
/* The task was created successfully. Delay for a short period to allow
the task to run. */
vTaskDelay( 100 );
/* What tag value is assigned to the task? The returned tag value is
stored in an integer, so cast to an integer to prevent compiler
iReturnedTaskHandle = ( int ) xTaskGetApplicationTaskTag( xHandle );
Copyright (C) 2004-2010 Richard Barry. Copyright (C) 2010-2016 Real Time Engineers Ltd.
Any and all data, files, source code, html content and documentation included in the FreeRTOSTM distribution or available on this site are the exclusive property of Real Time Engineers Ltd..
See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Real Time Engineers Ltd.