Download FreeRTOS
 

Quality RTOS & Embedded Software

KERNEL
WHAT'S NEW
Simplifying Authenticated Cloud Connectivity for Any Device.
Designing an energy efficient and cloud-connected IoT solution with CoAP.
Introducing FreeRTOS Kernel version 11.0.0:
FreeRTOS Roadmap and Code Contribution process.
OPC-UA over TSN with FreeRTOS.

pvTimerGetTimerID
[Timer API]

timers.h
 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 expired.

The timer identifier can also be used to store data in the timer between calls to the timer’s callback function.

Parameters:
xTimer   The timer being queried.
Returns:
The ID assigned to the timer being queried.
Example usage:

See the examples provided on the xTimerCreate() documentation page and the vTimerSetTimerID() documentation page.




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