xTimerDelete
[定时器 API]

 BaseType_t xTimerDelete( TimerHandle_t xTimer,
                             TickType_t xBlockTime );

软件定时器功能由定时器服务/守护进程任务提供。 许多 公共 FreeRTOS 定时器 API 函数通过定时器命令队列 向定时器服务任务发送命令。 定时器命令队列是 RTOS 内核本身的私有队列， 应用程序代码无法直接访问该队列。 定时器命令队列的长度 由 configTIMER_QUEUE_LENGTH 配置常量设置。

xTimerDelete() 可删除以前使用 xTimerCreate() API 函数创建的定时器。请注意，删除静态分配的定时器时，在 xTimerIsTimerActive() 指示该定时器处于非活动状态之前，无法重复使用其静态内存。

必须将 configUSE_TIMERS 配置常量设置为 1， xTimerDelete() 才可用。

参数：

xTimer	正在删除的定时器的句柄。
xBlockTime	在调用 xTimerDelete() 时队列已满的情况下， 指定调用任务应保持阻塞状态 以等待删除命令成功发送到定时器命令队列的时间 （以 tick 为单位）。 如果 启动 RTOS 调度器之前调用 xTimerStop()，则会忽略 xBlockTime。

返回：

如果即使经过 xBlockTime（以 tick 为单位） 之后仍无法将删除命令发送到定时器命令队列，则将返回 pdFAIL。 如果能将此命令成功发送到定时器命令队列，则返回 pdPASS 则返回 pdPASS。 实际处理命令的时间取决于 定时器服务/守护进程任务相对于系统中其他任务的 优先级。 定时器服务/守护进程任务的优先级 由 configTIMER_TASK_PRIORITY 配置常量设置。

请参阅 xTimerChangePeriod() 文档页面上的示例。