void *pvTimerGetTimerID( TimerHandle_t xTimer );
Returns the ID assigned to the software timer.
IDs are assigned to timers using the pvTimerID parameter of the call to
xTimerCreate() that was used to
create the timer.
An identifier (ID) is assigned to a timer when the timer is created, and can be
changed at any time using the vTimerSetTimerID() API function.
If the same callback function is assigned to multiple timers, the timer identifier
can be inspected inside the callback function to determine which timer actually
The timer identifier can also be used to store data in the timer between calls
to the timer’s callback function.
The timer being queried.
The ID assigned to the timer being queried.
See the examples provided on the xTimerCreate() documentation page
and the vTimerSetTimerID() documentation page.
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.