Function esp_idf_svc::sys::pvTimerGetTimerID

source ยท
pub unsafe extern "C" fn pvTimerGetTimerID(
    xTimer: *mut tmrTimerControl,
) -> *mut c_void
Expand description

Returns 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, and by calling the vTimerSetTimerID() API function.

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 queried.

@return The ID assigned to the timer being queried.

Example usage:

See the xTimerCreate() API function example usage scenario.