Function esp_idf_svc::sys::esp_timer_get_expiry_time

source ยท
pub unsafe extern "C" fn esp_timer_get_expiry_time(
    timer: *mut esp_timer,
    expiry: *mut u64,
) -> i32
Expand description

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

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

@note This API returns a valid expiry time only for a one-shot timer. It returns an error if the timer handle passed to the function is for a periodic timer.

@param timer timer handle allocated 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