esp_idf_sys

Function esp_timer_get_expiry_time

Source
pub unsafe extern "C" fn esp_timer_get_expiry_time(
    timer: esp_timer_handle_t,
    expiry: *mut u64,
) -> esp_err_t
Expand description

@brief Get the expiry time of a one-shot timer

This function fetches the expiry time of a one-shot timer.

@note Passing the timer handle of a periodic timer will result in an error.

@param timer timer handle created using esp_timer_create() @param expiry memory to store the timeout value in microseconds @return - ESP_OK on success - ESP_ERR_INVALID_ARG if the arguments are invalid - ESP_ERR_NOT_SUPPORTED if the timer type is periodic