Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

KernelinsideSoftware timers

Updated May 2025

xTimerGetReloadMode, uxTimerGetReloadMode

[Timer API]

task.h

1BaseType_t  xTimerGetReloadMode( TimerHandle_t xTimer );
2UBaseType_t uxTimerGetReloadMode( TimerHandle_t xTimer );

Queries the 'mode' of the software timer referenced by the xTimer handle.

The mode can be either an auto-reloaded timer, which automatically resets itself each time it expires, or a one-shot timer, which will expire only once unless it is manually restarted.

xTimerGetReloadMode and uxTimerGetReloadMode only differ in their return type. xTimerGetReloadMode returns BaseType_t to match the type of the actual return value pdTRUE/pdFALSE. uxTimerGetReloadMode is provided for backward compatibility and new applications should use xTimerGetReloadMode instead.

These API functions are only available if the FreeRTOS 'timers.c' source file is included in the built project, and configUSE_TIMERS is set to 1 in FreeRTOSConfig.h.

Parameters:

Returns:

pdTRUE if the timer with handle xTimer is an auto-reload timer, otherwise pdFALSE.