Function esp_idf_sys::vTimerSetTimerID

source ยท
pub unsafe extern "C" fn vTimerSetTimerID(
    xTimer: TimerHandle_t,
    pvNewID: *mut c_void,
)
Expand description

void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID );

Sets the ID assigned to the timer.

IDs are assigned to timers using the pvTimerID parameter of the call to xTimerCreated() that was used to create the timer.

If the same callback function is assigned to multiple timers then the timer ID can be used as time specific (timer local) storage.

@param xTimer The timer being updated.

@param pvNewID The ID to assign to the timer.

Example usage:

See the xTimerCreate() API function example usage scenario.