Quality RTOS & Embedded Software

KERNEL
WHAT'S NEW
FreeRTOS Extended Maintenance Program (EMP) registration now open.
FreeRTOS-Plus-TCP v3.0.0 released:
Featured FreeRTOS IoT Integrations:
Delta Over-the-Air Updates:
December 2021 Releases:

xTimerGetReloadMode
uxTimerGetReloadMode
[Timer API]

task.h

BaseType_t  xTimerGetReloadMode( TimerHandle_t xTimer );
UBaseType_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:
xTimer The handle of the timer to query. The handle will have been returned from the call to xTimerCreate() or xTimerCreateStatic() which are used to create the timer.
Returns:
pdTRUE if the timer with handle xTimer is an auto-reload timer, otherwise pdFALSE.





Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.