BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer );
Queries a software timer to see if it is active or dormant.
A timer will be dormant if:
- It has been created but not started, or
- It is an expired one-shot timer that has not been restarted.
Timers are created in the dormant state. The xTimerStart(),
API functions can all be used to transition a timer into the active state.
The timer being queried.
pdFALSE will be returned if the timer is dormant. A value other than pdFALSE will be returned if the timer is active.
/* This function assumes xTimer has already
been created. */
void vAFunction( TimerHandle_t xTimer )
/* or more simply and equivalently
"if( xTimerIsTimerActive( xTimer ) )" */
if( xTimerIsTimerActive( xTimer ) != pdFALSE )
/* xTimer is active, do something. */
/* xTimer is not active, do something else. */
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.