BaseType_t xTimerDelete( TimerHandle_t xTimer,
TickType_t xBlockTime );
Software timer functionality is provided by a timer service/daemon task. Many of the
public FreeRTOS timer API functions send commands to the timer service task
through a queue called the timer command queue. The timer command queue is
private to the RTOS kernel itself and is not directly accessible to application
code. The length of the timer command queue is set by the
configTIMER_QUEUE_LENGTH configuration constant.
xTimerDelete() deletes a timer that was previously created using the
xTimerCreate() API function.
The configUSE_TIMERS configuration constant must be set to 1 for
xTimerDelete() to be available.
The handle of the timer being deleted.
Specifies the time, in ticks, that the calling task should
be held in the Blocked state to wait for the delete command to be successfully
sent to the timer command queue, should the queue already be full when
xTimerDelete() was called. xBlockTime is ignored if xTimerDelete() is called
before the RTOS scheduler is started.
pdFAIL will be returned if the delete command could not be
sent to the timer command queue even after xBlockTime ticks had passed.
pdPASS will be returned if the command was successfully sent to the timer
command queue. When the command is actually processed will depend on the
priority of the timer service/daemon task relative to other tasks in the
system. The timer service/daemon task priority is set by the
configTIMER_TASK_PRIORITY configuration constant.
See the example on the xTimerChangePeriod() documentation page.
Copyright (C) 2004-2010 Richard Barry. Copyright (C) 2010-2016 Real Time Engineers Ltd.
Any and all data, files, source code, html content and documentation included in the FreeRTOSTM distribution or available on this site are the exclusive property of Real Time Engineers Ltd..
See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Real Time Engineers Ltd.